Qaa WS

Query as a Web Service Guide
BusinessObjects Enterprise XI 3.0
Windows
Copyright © 2008 Business Objects. All rights reserved. Business Objects owns the following
U.S. patents, which may cover products that are offered and licensed by Business
Objects: 5,555,403; 5,857,205; 6,289,352; 6,247,008; 6,490,593; 6,578,027;
6,831,668; 6,768,986; 6,772,409; 6,882,998; 7,139,766; 7,299,419; 7,194,465;
7,222,130; 7,181,440 and 7,181,435. Business Objects and the Business Objects
logo, BusinessObjects, Business Objects Crystal Vision, Business Process On
Demand, BusinessQuery, Crystal Analysis, Crystal Applications, Crystal Decisions,
Crystal Enterprise, Crystal Insider, Crystal Reports, Desktop Intelligence, Inxight,
the Inxight Logo, LinguistX, Star Tree, Table Lens, ThingFinder, Timewall, Let
there be light, Metify, NSite, Rapid Marts, RapidMarts, the Spectrum Design, Web
Intelligence, Workmail and Xcelsius are trademarks or registered trademarks in
the United States and/or other countries of Business Objects and/or affiliated
companies. All other names mentioned herein may be trademarks of their respective
owners.
Third-party Business Objects products in this release may contain redistributions of software
Contributors licensed from third-party contributors. Some of these individual components may
also be available under alternative licenses. A partial listing of third-party
contributors that have requested or permitted acknowledgments, as well as required
notices, can be found at: http://www.businessobjects.com/thirdparty
Contents
Chapter 1 Overview of Query as a Web Service 7
Overview of Query as a Web Service..........................................................8
Architecture of Query as a Web Service......................................................8
Chapter 2 Installing Query as a Web Service 11

Installation pre-requisites for Query as a Web Service.............................12
Installing and validating Query as a Web Service.....................................12
Troubleshooting Query as a Web Service.................................................14
Launching the CMS first.......................................................................15
Setting the CMS name first .................................................................15
Ensuring high availability of the CMS...................................................15
Activating the web service provider traces in a test environment .......16
Configuring Query as a Web Service Client to connect to a reverse proxy
web server ................................................................................................17
Setting Query as a Web Service background user ...................................18
Chapter 3 Launching the Query as a Web Service Client Tool 21

Launching Query as a Web Service..........................................................22
Logging in for the first time to Query as a Web Service............................23
Chapter 4 Creating and Publishing a Query as a Web Service 25

Creating and publishing a Query as a Web Service..................................26
Creating a Prompt in your Query as a Web Service..................................28
Using context with your Query as a Web Service......................................30
Query as a Web Service Guide 3

Contents
Chapter 5 Managing Query as a Web Service 33

Viewing Query as a Web Service properties.............................................34
Viewing queries in a web browser .......................................................34
Deploying queries to another web server..................................................35
Deploying to another server using the Query as a Web Service client
tool.............................................................................................................36
Deploying Query as a Web Service from Import Wizard ..........................37
Deploying Query as a Web Service from a BIAR file................................38
Editing a Query as a Web Service.............................................................38
Deleting a Query as a Web Service...........................................................39
Copying a Query as a Web Service...........................................................39
Setting advanced parameters for Query as a Web Service......................39
Web Service base URL........................................................................40
Session time-out in seconds................................................................40
Authentication mode.............................................................................40
Query as a Web Service Query Panel Options.........................................41
Chapter 6 Consuming Query as a Web Service with Different Applications 43

Consuming a Query as a Web Service via WSDL....................................44
Consuming a Query as a Web Service in Crystal Xcelsius.......................44
Cross-domain issue..............................................................................45
Selecting the web service.....................................................................45
Input messages....................................................................................46
Output messages.................................................................................46
Authentication in Xcelsius....................................................................47
Consuming a Query as a Web Service in Crystal Reports........................47
Consuming a Query as a Web Service in Microsoft Office InfoPath.........48
4 Query as a Web Service Guide

Contents
Chapter 7 Query as a Web Service Best Practices and Limitations 51

Best Practices using Query as a Web Service..........................................52
Limitations using Query as a Web Service................................................52
Appendix A Get More Help 53
Index 57

Contents

Overview of Query as a
Web Service
1
1 Overview of Query as a Web Service
Overview of Query as a Web Service

Query as a Web Service provides new easy ways to analyze information
through user-driven client solutions for businesses.
Business Intelligence (BI) content is usually bound to a specific user interface

of BI tools. Query as a Web Service changes this by allowing BI content to
be delivered to any user interface that can process Web Services.
Using Query as a Web Service, business users define their own query from
a universe, and then easily and securely publish that query as a standalone
web service.
Query as a Web Service provides new client solutions for businesses. For
example, it enables Crystal Xcelsius to aggregate multiple disparate data
sources into a trusted BI view.
Query as a Web Service also enables a range of client-side solutions in tools

such as:Microsoft Office, Excel, and InfoPath
• SAP NetWeaver
• OpenOffice
• Business rules and process management applications
• Enterprise Service Bus platforms
Note: Business Objects provides a wide range of Web Services for

developers. Developers use these Web Services in IDEs with languages
such as C# and Java. For more information, go to:
http://diamond.businessobjects.com
Architecture of Query as a Web Service

Query as a Web Service is designed to work on top of any Windows
application the same way as other web services.
Query as a Web Service is based on the W3C web service specifications

SOAP, WSDL, and XML. It has two main components:
• Server component

Architecture of Query as a Web Service 1
The server component (included in BusinessObjects XI R3) stores the
Query as a Web Service catalog and hosts the published Web Services.
• Client tool
This is where business users create and publish Query as a Web Service.
You can install the client tool on several machines that can then access
and share the same Query as a Web Service catalog stored on the server.
The client tool communicates with the server components via Web
Services.
Figure 1-1: Query as a Web Service architecture diagram

1 Overview of Query as a Web Service
Architecture of Query as a Web Service

Installing Query as a Web
Service
2
2 Installing Query as a Web Service
Installation pre-requisites for Query as a Web Service
Installation pre-requisites for Query as a

Web Service
There are a few steps to preform before installing. Before installing Query
as a Web Service, please read the Terms of Use agreement and conditions
and ensure you have met the pre-requisites described below.
The following must be installed on the server:

• BusinessObjects XI 3.0 Enterprise Edition
• Web Services
• Tomcat or another supported Web Application and JDK
For an updated list of supported Web Applications and versions, see:
http://support.businessobjects.com/supported_platforms/
The following must be installed on the client before you install Query as a
Web Service:
• .NET 1.1
The client platform must be supported for use with BusinessObjects XI

3.0. For an updated list of supported versions, see:
http://support.businessobjects.com/supported_platforms/
Installing and validating Query as a Web

Service
The server component of Query as a Web Service installs automatically as
part of BusinessObjects Enterprise XI 3.0 with Web Intelligence.
You must then install the client tool on every machine that will access the
server via Web Services.
You must have a separate license for the client tool. It is not covered by the
general license for BusinessObjects XI 3.0.

Installing Query as a Web Service
Installing and validating Query as a Web Service 2
1. Navigate to the Add-Ons\Query as a Web Service folder on the
BusinessObjects Enterprise collaterals CD or locate the Query as a Web
Service setup.exe file on your network.
2. Double-click setup.exe to launch the Query as a Web Service Wizard.
3. Follow the on-screen instructions in the Query as a Web Service
Installation Wizard to complete the installation procedure.
You are ready to validate your installation.
4. To validate the installation, open a browser and type the following URL
http://[server]:[port]/dswsbobje, where [server] corresponds to
your web server address and [port] corresponds to the port where you
set up in your web server. The default used by Tomcat is 8080. dswsbobje
is the default name of the Web Service provider web application.
5. Click the Validate link button to get a status of the installation.

6. Browse down to make sure Query as a Web Service is installed. You will
see Found resource:/managequeryasaservice.wsd

Troubleshooting Query as a Web Service
7. In your browser, type the following URL: http://[server]:[port]/dsws

bobje/qaawsservices, where [server] corresponds to your server
address and [port] corresponds to the port where you set up your web
server.
Your browser page appears and contains the title "Available QaaWS
services". This page contains a list of the Query as a Web Service that
have already been created on this system.

Here are a few tips to follow in the event that you have installation issues.

Troubleshooting Query as a Web Service 2
Launching the CMS first
Ensure that the CMS is launched before Tomcat.

During launch of Tomcat, in the initialization of the Servlet, QaaWS cache
reads the definition of the QaaWS in the repository to build its cache. Thus,
you must ensure that the CMS is launched before Tomcat.
If you launch the CMS automatically using the NT Services, you do not need
to do this manually.
Setting the CMS name first
By default, the Web Services connects to the local machine name's CMS.
If you want to change to a dedicated CMS, you must change the domain
property in the dsws.properties file. To locate the dsws.properties file,
browse to...
This information complements what is available in the Central Management

System documentation.
1. Stop Tomcat.
2. Open the installation path folder of BusinessObjects Enterprise XI
3.0: [InstallationPath]\Tomcat55\webapps\dswsbobje\WEB-
INF\classes
3. Open the file dsws.properties and locate: domain=
4. Enter your CMS name.
5. Close and save the dsws.properties file.
6. Start Tomcat.
Related Topics
• Installing and validating Query as a Web Service on page 12
Ensuring high availability of the CMS
The CMS can have only one single CMS system database. The connection
with CMS system database can be lost for the following reasons:

• because the database is down

• because of a network outage between CMS and CMS System database
• because of a software or hardware failure of CMS machine or application
In any of these cases, deploying two CMS decreases the probability that
both CMSs will be unable to communicate with the CMS system database
that is on the CMS machine.
On the other hand, if the CMS system database is down then all CMSs will
be unable to process incoming requests without errors, regardless of whether
there are a single CMS or multiple CMSs in the cluster.
You can limit the risk by employing the fault tolerance solutions provided by
the database vendor. Each database vendor provides fault tolerance solutions
to minimize the risk of the database being unavailable. One fault tolerance
option may be to set up a secondary mirror database that runs on a secondary
server. For example, if the first database is out the tns.ora file is
automatically updated to point to the secondary database server. Since
available fault tolerance measures are database-specific, see the
documentation for your specific database vendor for more information on
fault tolerance measures.
Note: If the feature is available and enabled, even if the system database
connection is lost, the CMS automatically re-establishes the database
connection without administrator intervention.
Activating the web service provider traces in a test

environment
If there is configuration issue, the Business Objects Administrator may be

required to set up traces to allow better troubleshooting.
Business Objects strongly recommends using traces only for troubleshooting

purposes in test environments.
1. In the Central Configuration Manager (CCM), stop "Apache Tomcat 5.5.20"
service.

Configuring Query as a Web Service Client to connect to a reverse proxy web server 2
2. Change the trace level.

By default Query as a Web Service only traces errors. You may be
requested to provide additional traces for customer assurance.
3. Edit log4j.properties located in [installationpath]\dswsbob
je\WEB-INF\classes\
4. Type the following in the properties file:log4j.logger.com.businessob
jects=DEBUG, BO1
5. Change the trace location.
By default, it traces in the output console output. If you want to trace a
file, comment the ConsoleAppender and uncomment the RollingFileAp
pender. If Tomcat is set as a service, you will trace in dswsbobje.log
found under the file pathC:\WINDOWS\system32.: # console appender
# log4j.appender.BO1=org.apache.log4j.ConsoleAppender #
log4j.appender.AXIS1=org.apache.log4j.ConsoleAppender
#rolling file appender log4j.appen
der.BO1=org.apache.log4j.RollingFileAppender log4j.appen
der.BO1.File=dswsbobje.log log4j.appender.BO1.Append=false
log4j.appender.BO1.MaxBackupIndex=5 log4j.appender.BO1.Max
FileSize=10
6. In the CCM, start "Apache Tomcat 5.5.20" service.
Configuring Query as a Web Service

Client to connect to a reverse proxy web
server
Reverse proxy is a network address translation of a machine from a URL in
a given network to a URL in another external network. Since Query as a

Setting Query as a Web Service background user
Web Service client binds to the Report Engine, Query and BICatalog Web
Service you must specify the external URL of the Web Services
wsresource4=QueryService|query web service alone|http://[myserv
er.mycompany.com]/dswsbobje/services/query
1. Locate the dsws.properties file.
This file is located in dswsbobje web application.
2. Update the following properties:
Property name Property value
ReportEngine|reportengine web ser

wsresource1 vicealone|http://[myserver.mycompany.com]
/dswsbobje/services/reportengine
BICatalog|bicatalog web service

wsresource2 alone|[myserver.mycompany.com] dswsbob
je/services/bicatalog
QueryService|query web service

wsresource4 alone|http:// [myserver.mycompany.com]/dsws
bobje/services/query
Setting Query as a Web Service

background user
Query as a Web Service definitions are stored in the repository. Query as a
Web Services Web Application needs a BusinessObjects account to handle
WSDL generation.
This account called QaaWSServletPrincipal and is pre-defined with minimal

rights.
If you change this pre-defined account using the CMC you need to update
the following properties in the dsws.properties file.
• qaaws.principal.username
• qaaws.principal.password
• qaaws.principal.authentication

Setting Query as a Web Service background user 2
To avoid security risk, create a dedicated user that does not have access to
documents or any other BI content.

Setting Query as a Web Service background user

Launching the Query as a
Web Service Client Tool
3
3 Launching the Query as a Web Service Client Tool
Launching Query as a Web Service
Launching Query as a Web Service

Once Query as a Web Service is installed, follow the steps below to launch
it.
• In the Windows Start menu, point to Programs > Business Objects XI
3 . 0 > BusinessObjects Enterprise > Query As A Web Service.
Note: To launch Query as a Web Service, you must use the Administrator
account or your user name must be in the user group QaaWS Group
Designer.
Either of the following occur:
• If you are logging in for the first time, the Manage Hosts dialog box
appears.
• If this is not your first login, the Select your credentials dialog box
appears.

Launching the Query as a Web Service Client Tool
Logging in for the first time to Query as a Web Service 3
Enter your system, user name, password and the user interface
language, then click OK.
Note: You can display Query as a Web Service user interface in any
language supported by the Business Objects XI Enterprise Suite. Select an
available language by clicking on the Interface drop-down list in the Select
your credentials dialog box when you log in. Only languages that have been
installed with Query as a Web Service display in the drop-down list.
Related Topics
• Logging in for the first time to Query as a Web Service on page 23
• Creating and publishing a Query as a Web Service on page 26
Logging in for the first time to Query as

a Web Service
The first time you log in, you need to define the system host where the web
services are installed. You only need to perform these steps once.
1. In the Manage Hosts dialog box, click Add.
The Edit a Host dialog box appears.
2. Type a system name in the Name field.

3 Launching the Query as a Web Service Client Tool
Logging in for the first time to Query as a Web Service
The URL is automatically entered.

3. Make sure the port is correct.
4. If the CMS is not on the same server as the Web Services, complete the
CMS field.
5. Enter a user name that will be used by default, then click OK.
The Manage Hosts dialog box reappears and the host name appears in
the list.
6. Click OK.
The Select your credentials dialog box appears.
7. Enter your password, then click OK.
The Query as a Web Service client tool appears.

Creating and Publishing a
Query as a Web Service
4
4 Creating and Publishing a Query as a Web Service
Creating and publishing a Query as a Web Service
Creating and publishing a Query as a

Web Service
Creating and publishing a query using Query as a Web Service is easy using
the Wizard. To create and publish your query:
1. Launch the Query as a Web Service client tool.
If you have not yet published a Query as a Web Service, the Publish
Query as a Web Service Wizard appears.
If you have already published a Query as a Web Service, click New to
access the wizard.
2. In the Web Service name field, enter a name for the Query as a Web
Service.
The characters are restricted to avoid problems during WSDL generation.
3. In the Web Service Description box, enter a description that will help you
and others re-use the query.
4. If you want to set advanced parameters, click Advanced Parameters.
For instructions, see Setting advanced parameters for Query as a Web
Service on page 39.
5. Click Next.
The Select a universe page appears.

Creating and Publishing a Query as a Web Service
Creating and publishing a Query as a Web Service 4
6. Select the universe from which you want to create the query, and then
click Next.
The Query Panel appears.
7. Create your query by dragging and dropping the objects into the Result
Objects and Filter Objects pane .
For information on query creation, see the Building Queries Using Web
Intelligence Query - HTML guide.
8. Click Next.

Creating a Prompt in your Query as a Web Service
Creating a Prompt in your Query as a

Web Service
You can create a prompt in a query to refine the query results.
Note: You cannot create a Query as a Web Service using nested prompts.
1. Select a prompt object, then click the right arrows until the value appears
in the Selected values pane.
2. Review the query prompts and contexts, if necessary, before displaying

the Preview page.

Creating a Prompt in your Query as a Web Service 4
3. The Web Service in pane contains the input parameters of the Web
Services you create. Each input parameter is linked to a filter prompt that
you created in the Filter Objects pane of the Query Panel.
4. Change the default value of the prompt by clicking the prompt icon.
Note: The name of the Prompt text is important because it will appear in
the list of input parameters of the query web service at runtime. The
prompt text appears in the Wizard, Step 4. Preview.
The Web Service out pane contains the output parameters of the Web
Services you create. The output parameters are linked to Result Objects
you put in the Query Panel; they are expressed as a result set.

Using context with your Query as a Web Service
When you run the query, the prompts you entered appear. The user is
required to select or input values to display the query results.
Using context with your Query as a Web

Service
You can define a Query that uses the same context. You select the context
at design-time and always reuse that context at run-time. Follow the example
below to learn how to create a query with a context.
1. Define a Query that requires the selection of a context, such as Sales or
Reservations in the Island Resorts marketing database.
2. Click Next to display the Select the Query Context window.
3. Of the two available contexts "Reservations" and "Sales", select "Sales".

4. Click OK, to display the Preview pane.
Note: The two contexts do not appear in the Input Parameters list. Once
you select the context in the query design step, the selected context is
stored in the query definition. At runtime, you cannot select a different
context than the one that is saved at design time — in our example
"Sales".
5. Click Next to display the Select the Query Context window.

6. Of the two available contexts "Reservations" and "Sales", select "Sales".

Using context with your Query as a Web Service 4
7. Click OK, to display the Preview pane.
Note: The two contexts do not appear in the Input Parameters list. Once
you select the context in the query design step, the selected context is
stored in the query definition. At runtime, you cannot select a different
context than the one that is saved at design time — in our example
"Sales".

Using context with your Query as a Web Service

Managing Query as a Web
Service
5
5 Managing Query as a Web Service
Viewing Query as a Web Service properties
Viewing Query as a Web Service

properties
When you launch the Query as a Web Service client tool, the Query Catalog
appears on the left side. It shows the queries you created.
This section describes how view the properties of a Query as a Web Service.
1. In the Query Catalog, select the Query as a Web Service you want.
The properties display on the right side of the panel.
2. To open the WSDL in a web browser, click the WSDL URL.
Viewing queries in a web browser
You can also view, in a web browser, your instances of Query as a Web
Service.
• Open a web browser, and go to the following URL:dswsbobje
http://<name of server>:<Tomcat port number>/dswsbobje/
qaawsservices

Managing Query as a Web Service
Deploying queries to another web server 5
Deploying queries to another web server

This section explains how to deploy to another server; that is, copy a Query
as a Web Service definition from one server to another. For example, you
can move a query definition from a development server to a test or production
server.
To deploy to another server, you have a choice of the following methods:

• the Query as a Web Service client tool
An advantage of this method is that the query will automatically point to
the web server on the new system.
• the Import Wizard
• a BIAR file

Deploying to another server using the Query as a Web Service client tool
Note: Before starting, make sure the universe and users are the same on
both machines. Use the Import Wizard or BIAR files to import universes and
users. It is important to have the same CUID during Import Wizard operations.
Deploying to another server using the

Query as a Web Service client tool
Using Query as a Web Service client, you can deploy queries to another
server once, using the same service name.
You can use the Deploy to another serveroption between two servers that
have the same version of Query as a Web Service installed. It is not possible
to migrate queries from one version to another using this option.
1. In the Query Catalog, select the Query as a Web Service whose definition
you want to copy.
2. Click Deploy to another server.
The Select Your Credentials dialog box appears.
3. Complete the information for the system on which you want to deploy the
Web Services, and then click OK.
The Query as a Web Service appears in the Publish Query as a Web
Service Wizard.
4. Publish the Query as a Web Service to the new system.

Deploying a Query as a Web Service definition to another server automatically
changes the WSDL location and the services execution location.
Note: You can customize this service-based URL using the wizard. You can
also make it dynamic in an Xcelsius project by using the Input Values text
box of the Web Services Connectivity. Using this functionality, you can switch
a dashboard from development to production by simply changing the URL.
You cannot deploy the same query Service Name more than once to the
same server. When you deploy to another server, Query as a Web Service
verifies the Service Name does not exist already and only displays the
available servers.
For instructions on how to publish to the new system, see below:

Deploying Query as a Web Service from Import Wizard 5
Related Topics
• Creating and publishing a Query as a Web Service on page 26
Deploying Query as a Web Service from

Import Wizard
To deploy using the Import Wizard, import the Query as a Web Service
definition from the source server to the destination server.
1. Launch the Import Wizard on the source server.
2. After logging in to the source CMS, select the target file to which you will
export the definitions.
3. In the Select objects to import pane of the Import Wizard dialog box,
select Import folders and objects then select Import application folders
and objects.
4. In the Select application folders and objects pane of the Import Wizard
dialog box, expand the QaaWS Folderthen the Query as a Web Service
definitions or Service Names you want.
5. Continue through the remaining steps of the Import Wizard by clicking
Next.
6. Open the Import Wizard on the destination server.
7. In the Source Environment dialog box, select the source file to which you
exported the definitions.
8. Log into the destination CMS.
and objects.
dialog box, select the Query as a Web Service definitions you want.
11. Continue through the remaining steps of the Import Wizard by clicking
Next.
12. After importing, point the newly-deployed query definition to the web
server on the destination system.

Deploying Query as a Web Service from a BIAR file
Deploying Query as a Web Service from

a BIAR file
Make sure the Import Wizard is installed on both the source and destination
server.
1. Open the Import Wizard on the source server.
2. After logging in to the source CMS, select the target BIAR file to which
you will export the definitions.
and objects.
dialog box, expand the QaaWS Folderthen the Query as a Web Service
definitions or Service Names you want.
5. Continue through the remaining steps of the Import Wizard.
6. Open the Import Wizard on the destination server.
7. In the Source Environment dialog box, select the BIAR file to which you
exported the definitions.
8. Log into the destination CMS.
9. In the Select Objects to Import dialog box, select Import folders and
objects > Import application folders and objects.
10. In the Select Application Folders and Objects dialog box, select the Query
as a Web Service definitions you want.
11. Continue through the remaining steps of the Import Wizard.
12. After importing, point the newly-deployed query definition to the web
server on the destination system.
Editing a Query as a Web Service

Editing a Query as a Web Service may change the associated WSDL, and
this could break the link that is used by others to communicate with Web
Services. Business Objects recommends that you notify users of any changes
you make.
1. In the Query Catalog, select the Query as a Web Service you want to
edit.
2. Click Edit.

Deleting a Query as a Web Service 5
Service Wizard.
3. Make the changes you want.

For instructions, see Creating and publishing a Query as a Web Service
on page 26.
Deleting a Query as a Web Service

To delete a query from the list of available queries:
delete.
2. Click Delete.
Copying a Query as a Web Service

You must change the name of the Query as a Web Service when you copy
it.
copy.
2. Click Copy.
Service Wizard.
The default name of the copied query is Copy_<name of original>.
3. Change the default name, if you want.

4. Go through the remaining pages of the wizard and, if you want, modify
the information.
Setting advanced parameters for Query

as a Web Service
You can set several advanced parameters by clicking the Advanced
parameters button on the bottom left of the Publish Query as a Web Service
Wizard.

Setting advanced parameters for Query as a Web Service
Web Service base URL
Reverse proxy is a network address translation of a machine from a URL in

a given network to a URL in another network, usually an external network
like the public internet.
Example: Using the base URL technique

A server called myserver.company.com within a company network could
be called: www.mycompany.com in the external network.
To support such a deployment, you must set up a Web Services base URL.
The base URL contains the external URL from which you want your Web
Service to be accessible, for example www.mycompany.com/dswsbobje/.
To use Query as a Web Service client tool with a reverse proxy Web Server,
see Configuring Query as a Web Service Client to connect to a reverse
proxy web server on page 17.
Session time-out in seconds
To improve the performance of Query as a Web Service, particularly the

cascading call scenario, the user's connection to the server is cached by the
web service provider. You can configure session time-out (in seconds) for
each Query as a Web Service connection. The default is 60 seconds.
For example, if a given user login calls service 1 and then under 60 seconds
calls service 2 with the same login (identical username and password), the
server reuses the same connection and reinitializes the session time-out.
Authentication mode
Authentication mode is the type of directory against which the

BusinessObjects XI platform validates the login.
Examples include Enterprise, LDAP, Windows AD, and SAP.
You can set the authentication mode so that it will be defined according to
the service, or by the consumer:

Query as a Web Service Query Panel Options 5
• Service
You, as administrator, select the authentication directory; all users
subsequently accessing the service authenticate on this directory (except
for the sessionID option).
All authentication directories supported by the server are available for
selection in the Authentication Mode drop-down list.
• Consumer defined
The consumer of the query selects the authentication mode as an input
parameter called authenticationType.
Query as a Web Service Query Panel

Options
You can set several options for the Query Panel in the Options dialog box.
To access the dialog box, click the Options icon in the Query Panel of
the Publish Query as a Web Service Wizard.
Duplicate rows
By default, the query will not return duplicate rows (this is different than in
earlier versions). If you want duplicate rows, select this check box.

Query as a Web Service Query Panel Options
Max fetched time

Enter the maximum date fetch time, in seconds. The default value "-1" means
that this option is deactivated and the universe connection will be taken into
account.
Max rows fetched

Enter the maximum number of rows to fetch. The default value "-1" means
that this option is deactivated and the universe connection will be taken into
account.
Sample result set

Enter the number of rows you want to return for a sample result set before
running the query.

Consuming Query as a Web
Service with Different
Applications
6
6 Consuming Query as a Web Service with Different Applications
Consuming a Query as a Web Service via WSDL
Consuming a Query as a Web Service via

WSDL
WSDL is an XML-based description of how to communicate using the web
service; that is, the protocol bindings and message formats required to interact
with the Web Services listed in its directory.
The supported operations and messages are described on a high level and
then bound to a concrete network protocol and message format. WSDL is
often used in combination with SOAP and XML schema to provide Web
Services via the Internet.
A client program connecting to a web service can read the WSDL to

determine what functions are available on the server.
To find the WSDL for a Query as a Web Service, select it in the Query
Catalog.
Consuming a Query as a Web Service in

Crystal Xcelsius
To consume a Query as a Web Service inside Crystal Xcelsius, use the Web
Service Connector.
The Web Service Connector component allows a Flash document created

in Xcelsius to communicate with Query as a Web Service via SOAP, using
point and click. The Xcelsius Flash document is self-contained and
communicates with the web service to display data visually. The only
prerequisite is that there be a SOAP-based web service available to the
Flash document.
The Web Service Connector component, when activated, creates a

SOAP-based message (basically an XML document) and sends it to the web
service. The web service responds with a SOAP-based message of its own.
The Web Service Connector component then sends this data to all the other
components, resulting in a live visual representation of your data.
There are many public Web Services available, and many different toolkits
and packages for SOAP-based Web Services. Using public Web Services
and packages that already have a web service on top is easy. You need only

Consuming Query as a Web Service with Different Applications
Consuming a Query as a Web Service in Crystal Xcelsius 6
a WSDL document for the web service. For Query as a Web Service, you
can find the WSDL in the properties of each web service by selecting it in
the Query Catalog.
See the Crystal Xcelsius User Guides for more information.
Cross-domain issue
After downloading the Xcelsius widget via the web, you may encounter
difficulty retrieving data with the Query as a Web Service client tool if the
Flash and the client tool come from different web domains.
This occurs for security reasons related to Macromedia Flash. The Flash
displayed in a browser is not permitted to access data residing outside the
web domain from which the Flash file format (SWF) originated.
The solution depends on whether your Xcelsius server and the Query as a
Web Service client tool are on the same or different machines.
Same machine
Open the Optional Parameters dialog box from the Advanced parameters
button and modify the Web Service Base URL so that it matches the web
domain from which you downloaded Xcelsius.
Different machines
For instructions, go to:
http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=tn_14213
Related Topics
• Web Service base URL on page 40
Selecting the web service
Selecting the web service involves pointing the Web Service Connector
component to the WSDL document.
1. When working on an Excel spreadsheet, double-click the Web Service
Connector component to open the Properties panel.

Consuming a Query as a Web Service in Crystal Xcelsius
2. Click Select Web Service.

The Select Web Service dialog box appears.
3. In the WSDL URL box, type or paste the location of the WSDL document.
4. Click Submit.
If there was an error, the WSDL document may not be fully validated or
it may not meet requirements of the Web Service Connector component.
5. In the Methods list, select the method you want to bind with.
For a given web service, you can bind to only one method per component.
6. Click OK.
The input and output messages are now available for you to tie to your
data.
Input messages
For input messages, only elements can be tied to data.
Use the "-" button to remove folders and elements. This prevents the folder
or field from being sent in the message.
The "+" button can be used to add a folder or a repeating element.
Output messages
For output messages, both elements and folders can be tied to data.
Selecting a folder displays the number of columns in that folder. When you
tie this to data, each element in the folder is assigned to a column in the
order the elements appear.
Selecting fewer columns limits the data that is bound to the number of
columns that you select. Selecting additional columns inserts blank columns.
If an element is repeating underneath the folder, only the first element will
be mapped to the column. The folders underneath the selected folder cannot
be mapped.

Consuming a Query as a Web Service in Crystal Reports 6
Use the "-" button to remove unnecessary elements. This contracts the view
of the tree and may reduce processing time in the Flash document.
Authentication in Xcelsius
Xcelsius provides an authentication mechanism that enables you to avoid

logging into InfoView twice with the same session ID.
Keep in mind the following rules if you customize authentication:

• An existing session ID is used only if the user name and password are
blank (if they are not hard coded or not passed as input values captured
by a dialog). This occurs when Query as a Web Service is running in
InfoView or Dashboard Manager.
• If the user name and password are not blank, then use these values to
authenticate the user. No session is created. This is the most scalable
scenario and is the preferred option for large-scale usage.
• If there is no pre-existing session (and username and password are blank),
Xcelsius displays the standard security dialog, in which a session is
created. This occurs when Xcelsius designers do not build their own
security dialog.

Crystal Reports
This section explains how Crystal Reports can consume Query as a Web
Service as a data source.
1. In the Crystal Reports Standard Report Creation Wizard, on the Data
page, create a new XML connection.
2. In the XML Type and Location page of the XML dialog box, select Use
Web Server Data Source, and then click Next.
The Web Services Location page appears.
3. In the HTTP WSDL URL field, type the WSDL of the selected Query as
a Web Service.
The Authentication page appears.

Consuming a Query as a Web Service in Microsoft Office InfoPath
4. Set Basic authentication (if you haven't already), and then click Next.
The Web Service, Port, and Method page appears.
5. Complete the information, and then click Finish.

The Enter Values dialog box appears.
6. Set the Web Services parameters with login, password, and prompts,
and then click OK.
The Data page of the Standard Report Creation Wizard re-appears.
7. Select one of the following options and click Next.

• runQueryAsServiceResponse
• runQueryAsServicetable
• runQueryAsServicerow
The Fields page appears.
8. Select the field to build your query on, and then click Next.
A report is created.
9. Refresh the report.

The correct parameters are shown in the report.

Microsoft Office InfoPath
This section explains how Microsoft Office InfoPath can consume Query as
a Web Service as a data source.
1. In InfoPath, access the Design a Form task list.
2. Click New From Data Connection.
The Data Connection Wizard appears.
3. Select Web Service, and then click Next.

4. Select Receive and Submit Data, and then click Next.
5. Type or browse for the WSDL file, and then click Next.
6. Select the web service operation, and then click Next.
7. Enter a name for the data connection, and then click Next.

Consuming a Query as a Web Service in Microsoft Office InfoPath 6
8. Type or browse for the web service you want users to submit their forms
to, and then click Next.
The Parameters page appears.
9. For each parameter, select Entire Form, and then click Next.
10. Type a name for the data connection submitting data, and then click Next.
The data form appears on the left, and the data source on the right.
11. Build the form, and then click Run Query.

Consuming a Query as a Web Service in Microsoft Office InfoPath

Query as a Web Service
Best Practices and
Limitations
7
7 Query as a Web Service Best Practices and Limitations
Best Practices using Query as a Web Service
Best Practices using Query as a Web

Service
More tips for creating Query as a Web Service
The documentation for Query as a Web Service is updated regularly. To

view the most up-to-date source, go to the online documentation library and
use the Search field to find the latest Query as a Web Service best practices.
http://support.businessobjects.com/documentation/product_guides/
Limitations using Query as a Web Service

You may encounter certain limitations when using Query as a Web Service.
These can occur when creating a query, or at run-time.
Limitations when creating a query

• Multi-cubes cannot be used
• Combined queries and subqueries cannot be used
• IndexAware prompts are not implemented
Also, keep in mind that the name of the Web Service and its metadata are
encoded to support various programming languages (such as C#, Java, C++,
VB, Flash).
Limitations at query run-time

• Object restrictions cannot be used

Get More Help
A
A Get More Help
Online documentation library

Business Objects offers a full documentation set covering all products and
their deployment. The online documentation library has the most up-to-date
version of the Business Objects product documentation. You can browse
the library contents, do full-text searches, read guides on line, and download
PDF versions. The library is updated regularly with new content as it becomes
available.
http://support.businessobjects.com/documentation/product_guides/
Additional developer resources

http://devlibrary.businessobjects.com
Online customer support

The Business Objects Customer Support web site contains information about
Customer Support programs and services. It also has links to a wide range
of technical information including knowledgebase articles, downloads, and
support forums.
http://www.businessobjects.com/support/
Looking for the best deployment solution for your company?

Business Objects consultants can accompany you from the initial analysis
stage to the delivery of your deployment project. Expertise is available in
relational and multidimensional databases, in connectivities, database design
tools, customized embedding technology, and more.
For more information, contact your local sales office, or contact us at:
http://www.businessobjects.com/services/consulting/
Looking for training options?

From traditional classroom learning to targeted e-learning seminars, we can
offer a training package to suit your learning needs and preferred learning
style. Find more information on the Business Objects Education web site:
http://www.businessobjects.com/services/training

Get More Help
A
Send us your feedback
Do you have a suggestion on how we can improve our documentation? Is
there something you particularly like or have found useful? Drop us a line,
and we will do our best to ensure that your suggestion is included in the next
release of our documentation:
mailto:documentation@businessobjects.com
Note: If your issue concerns a Business Objects product and not the
documentation, please contact our Customer Support experts. For information
about Customer Support visit: http://www.businessobjects.com/support/.
Business Objects product information

For information about the full range of Business Objects products, visit:
http://www.businessobjects.com.

A Get More Help

Index
A L
architecture launching 22
understanding 8 logging in 23
C O
CMS database online documentation
preventing failures 15 accessing 52
configuring overview 8
reverse proxy 17
context
in queries 26
P
copying prompts
how to 39 creating 28
creating publishing
prompts 28 queries 26
queries 26
Q
D
queries
deleting copying 39
queries 39 creating 26
deploying deleting 39
webservices to another server, publishing publishing 26
webservices to another server 36 using context 26
documentation Query as a Web Service
accessing online library 52 understanding 8
I R
installation reverse proxy
activate trace logging 16 configuring 17
launch CMS first 15

Index
S T
starting 22 tips
first time 23 using Query as a Web Service 52
troubleshooting
fault tolerance options 15
tips 14

Qaa WS

Uploaded by

Copyright:

Available Formats

Qaa WS

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Qaa WS

Uploaded by

Copyright:

Available Formats

Query as a Web Service Guide

BusinessObjects Enterprise XI 3.0

Chapter 2 Installing Query as a Web Service 11

Chapter 3 Launching the Query as a Web Service Client Tool 21

Chapter 4 Creating and Publishing a Query as a Web Service 25

Query as a Web Service Guide 3

Chapter 5 Managing Query as a Web Service 33

Chapter 6 Consuming Query as a Web Service with Different Applications 43

4 Query as a Web Service Guide

Chapter 7 Query as a Web Service Best Practices and Limitations 51

Appendix A Get More Help 53

Query as a Web Service Guide 5

6 Query as a Web Service Guide

Overview of Query as a Web Service

Business Intelligence (BI) content is usually bound to a specific user interface

Query as a Web Service also enables a range of client-side solutions in tools

Note: Business Objects provides a wide range of Web Services for

Architecture of Query as a Web Service

Query as a Web Service is based on the W3C web service specifications

8 Query as a Web Service Guide

Figure 1-1: Query as a Web Service architecture diagram

Query as a Web Service Guide 9

10 Query as a Web Service Guide

Installation pre-requisites for Query as a

The following must be installed on the server:

The client platform must be supported for use with BusinessObjects XI

Installing and validating Query as a Web

12 Query as a Web Service Guide

5. Click the Validate link button to get a status of the installation.

Query as a Web Service Guide 13

7. In your browser, type the following URL: http://[server]:[port]/dsws

Troubleshooting Query as a Web Service

14 Query as a Web Service Guide

Launching the CMS first

Ensure that the CMS is launched before Tomcat.

Setting the CMS name first

This information complements what is available in the Central Management

Ensuring high availability of the CMS

Query as a Web Service Guide 15

• because the database is down

Activating the web service provider traces in a test

If there is configuration issue, the Business Objects Administrator may be

Business Objects strongly recommends using traces only for troubleshooting

16 Query as a Web Service Guide

2. Change the trace level.

6. In the CCM, start "Apache Tomcat 5.5.20" service.

Configuring Query as a Web Service

Query as a Web Service Guide 17

Property name Property value

ReportEngine|reportengine web ser

BICatalog|bicatalog web service

QueryService|query web service

Setting Query as a Web Service

This account called QaaWSServletPrincipal and is pre-defined with minimal

18 Query as a Web Service Guide

Query as a Web Service Guide 19

20 Query as a Web Service Guide

Launching Query as a Web Service

22 Query as a Web Service Guide