Oracle® Fusion Middleware

User's Guide for Oracle Business Intelligence Discoverer Web Services API

11g Release 1 (11.1.1)

E10412-03

January 2011

This document describes the Discoverer Web Services API. It also provides reference information to help you use the API to access Discoverer connections and workbooks.

Oracle Fusion Middleware User's Guide for Oracle Business Intelligence Discoverer Web Services API 11g Release 1 (11.1.1)

E10412-03

Copyright © 2011, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Contents

Preface

- Intended Audience

- Documentation Accessibility

- Oracle BI Discoverer Keyboard Navigation

- Related Documents

- Conventions

- JGoodies License Agreement

1 Introducing the Discoverer Web Services API

- 1.1 What is the Simple Object Access Protocol?

- 1.2 What are the Oracle BI Discoverer Web Services?

- 1.3 What is the SOAP endpoint URL for Discoverer Web Services?

- 1.4 What is the WSDL format?

- 1.5 About authentication and authorization

- 1.6 What modes of connecting to Discoverer are supported?

- 1.7 About maintaining Discoverer Web Service sessions

- 1.8 About managing the Discoverer session pool size

- 1.9 What are the availability requirements?

- 1.10 About error messages

- 1.11 How do you diagnose problems?

- 1.12 What is required to invoke the Discoverer Web Services?

- 1.12.1 Defining a trusted user to access Discoverer Web Services

- 1.12.2 Verifying access to the Discoverer Web Services

- 1.12.3 Setting values for Discoverer Web Services using Oracle Fusion Middleware Control

- 1.12.4 Creating web service client stubs (web service proxy)

- 1.12.5 Setting the Session Maintain Property

- 1.12.6 Writing a client application to invoke web services using generated web service client stubs

- 1.13 What is a typical flow of events for accessing Discoverer Web Services API to return results?

- 1.14 Typical flow of events: Detailed task examples

- 1.14.1 Provide the credentials to invoke Discoverer Web Services

- 1.14.2 Use the identifier to invoke login()

- 1.14.3 Secure Access to Discoverer Web Services for Oracle E-Business Suite Users

- 1.14.4 Inspect the connection information by invoking getConnectionList()

- 1.14.5 Select a particular connection and invoke getFolderEntryList()

- 1.14.6 Select a particular worksheet by invoking getWorksheetList()

- 1.14.7 Get the layout of the worksheet by invoking getLayoutMetadata()

- 1.14.8 Select the parameter metadata for a worksheet by invoking getParameterMetadata()

- 1.14.9 Select a worksheet parameter and obtain its LOVs by invoking getParameterValueList()

- 1.14.10 Select worksheet parameters and obtain LOVs in the cascading style by invoking getCascadeParameterValueList()

- 1.14.11 Submit a worksheet query (including parameters) by invoking submitWorksheetQuery()

- 1.14.12 Check the status of the query by invoking getQueryStatus()

- 1.14.13 View worksheet data on completion of the query by invoking getWorksheetData()

- 1.14.14 Log out, by invoking Logout()

- 1.15 Example of a Java class that invokes Discoverer Web Services

2 Discoverer Web Services API Reference

- 2.1 AppsConnect

- 2.2 getConnectionList

- 2.3 getFolderEntryList

- 2.4 getLayoutMetaData

- 2.5 getParameterMetaData

- 2.6 getParameterValueList

- 2.7 getCascadeParameterValueList

- 2.8 getQueryStatus

- 2.9 getVersion

- 2.10 getViewerURL

- 2.11 getWorksheetData

- 2.12 getWorkSheetList

- 2.13 isSessionValid

- 2.14 login

- 2.15 logout

- 2.16 requestQueryCancel

- 2.17 submitWorksheetQuery

Index

Preface

Welcome to the Oracle Fusion Middleware User's Guide for Oracle Business Intelligence Discoverer Web Services API!

Intended Audience

This guide is intended for developers of applications that use Discoverer data through Discoverer Web Services. Readers are assumed to have a working knowledge of Web services.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/support/contact.html or visit http://www.oracle.com/accessibility/support.html if you are hearing impaired.

Oracle BI Discoverer Keyboard Navigation

Oracle BI Discoverer supports standard keyboard navigation. Standard keyboard navigation includes the use of the tab key, mnemonics (using the Alt key and the underlined character), and accelerators (such as Alt+F4 to exit a window).

Related Documents

You can access the documents referenced in this guide, and other information about Oracle Business Intelligence (for example, whitepapers, best practices, documentation updates, other collateral) on Oracle Technology Network at:

http://www.oracle.com/technology

Conventions

Conventions used in this manual are shown in the table below:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

< >

Angle brackets enclose user-supplied names or values.

[]

Square brackets enclose optional clauses from which you can choose one or none.

Menu name | Command

Text in this format conveys a sequence of menu choices; for example, choose the menu, then the command under that menu.

For more information about the Discoverer Web Service API methods, see "Discoverer Web Services API Reference".

JGoodies License Agreement

Oracle Business Intelligence includes the JGoodies software, whose License Agreement follows:

Copyright© 2003 JGoodies Karsten Lentzsch. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

- Neither the name of JGoodies nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

1 Introducing the Discoverer Web Services API

This chapter introduces the Discoverer Web Services API and describes how to use the API. It contains the following topics:

- "What is the Simple Object Access Protocol?"

- "What are the Oracle BI Discoverer Web Services?"

- "What is the SOAP endpoint URL for Discoverer Web Services?"

- "What is the WSDL format?"

- "About authentication and authorization"

- "What modes of connecting to Discoverer are supported?"

- "About maintaining Discoverer Web Service sessions"

- "About managing the Discoverer session pool size"

- "What are the availability requirements?"

- "About error messages"

- "How do you diagnose problems?"

- "What is required to invoke the Discoverer Web Services?"

- "What is a typical flow of events for accessing Discoverer Web Services API to return results?"

- "Typical flow of events: Detailed task examples"

- "Example of a Java class that invokes Discoverer Web Services"

1.1 What is the Simple Object Access Protocol?

SOAP (Simple Object Access Protocol) is a World Wide Web Consortium (W3C) recommendation for an XML protocol for exchanging information on the Web.

1.2 What are the Oracle BI Discoverer Web Services?

The Oracle BI Discoverer Web Services are part of an Application Programming Interface (API) that enables a client to do the following:

- Obtain Discoverer connections, workbooks, and worksheets

- Execute worksheet queries

- Obtain worksheet content using the SOAP protocol (version 1.1 with JAX-WS/document wrapped format)

1.3 What is the SOAP endpoint URL for Discoverer Web Services?

The SOAP endpoint URL for Discoverer Web Services is http(s)://<host>:<port>/discoverer/wsi.

1.4 What is the WSDL format?

The WSDL (Web Services Definition Language) format is an industry standard that formally defines services and methods, and is used to define Discoverer Web Service APIs. Proxy classes for the services can be generated automatically.

Notes

- The WSDL can be accessed from http(s)://<host>:<port>/discoverer/wsi?wsdl

- This guide assumes that WSDL, SOAP technologies, and the method of generating client code from WSDL is known to a web services developer.

1.5 About authentication and authorization

The Discoverer Web Services are accessible only by trusted users. You must obtain the trusted user name and password set up by the Discoverer middle-tier administrator, to use these credentials in your code.

For a code example that includes user credentials, see Example 1-4, "Set credentials to access the protected web service".

For information about how to create trusted users, see Defining a trusted user to access Discoverer Web Services.

1.6 What modes of connecting to Discoverer are supported?

The Discoverer Web Services support Oracle Single Sign-On , Oracle Applications Single Sign-On, and public connections in the current release.

1.7 About maintaining Discoverer Web Service sessions

The Discoverer Web Services are stateful in nature. In other words, every instance of the web service client stub needs to have a single HTTP session with the Discoverer Web Service. This HTTP session can be used for all web service operations, for all client application users. For every user, the client application needs to call the login method, to inform the Discoverer Web Service about a new user session. Every user session is associated with a dedicated Discoverer session on the server side which is either created or reused from the Discoverer session pool. The associated Discoverer session is used in all interactions with the user. The client application must ensure that it calls the logout method after completing all operations for the user.

The HTTP session established between the web service client and the server is tracked by cookies and is managed by the web service.

1.8 About managing the Discoverer session pool size

It is useful to know the Discoverer session pool size, because every login() call and subsequent data fetching operation requires a Discoverer session, and every logout() call releases the session.

The maximum session pool size value can be configured (in configuration.xml) using Oracle Fusion Middleware Control. The Discoverer session clean-up operation runs periodically removing any stale or inactive DiscovererSession objects from the pool.

The SSOusername, Connectionkey, Workbook, Worksheet, and Locale methods are all used to determine which Discoverer sessions to pick up, to optimize allocation of Discoverer sessions for new login requests.

1.9 What are the availability requirements?

The Discoverer Web Services can be distributed across a cluster and have no dependency on a single point of failure. Transparent failover is not supported; therefore in the event of a failure, each client must authenticate again to create new user sessions.

1.10 About error messages

A web service API call can result in an exception that must be handled by the client. Error messages are displayed using the locale that was selected during login.

1.11 How do you diagnose problems?

You can diagnose problems from log files and from web service exceptions. You can view log entries using Oracle Fusion Middleware Control. For more information, see Oracle Fusion Middleware Configuration Guide for Oracle Business Intelligence Discoverer.

1.12 What is required to invoke the Discoverer Web Services?

To invoke the Discoverer Web Services you must comply with the following:

- "Defining a trusted user to access Discoverer Web Services"

- "Verifying access to the Discoverer Web Services"

- "Setting values for Discoverer Web Services using Oracle Fusion Middleware Control"

- "Creating web service client stubs (web service proxy)"

- "Setting the Session Maintain Property"

- "Writing a client application to invoke web services using generated web service client stubs"

1.12.1 Defining a trusted user to access Discoverer Web Services

Only trusted users can access Discoverer Web Services. You create trusted users by using the WebLogic Server Administration Console. For more information about creating users, see the "Create Users" topic in the WebLogic Administration Console Online Help.

Note:
By default, the Administrators group is assigned a scoped security role for the Discoverer application. To provide access to Discoverer Web Services, you can add the new user to the Administrators group.
For more information about adding users to groups, see "Add users to groups topic" in the WebLogic Administration Console Online Help.

For the new user to access Discoverer Web Services, you must assign the Discoverer scoped security role to the new user. For more information about adding users to security roles, see the "Add users to roles" topic in the WebLogic Administration Console Online Help.

1.12.2 Verifying access to the Discoverer Web Services

Before you create a Java class to invoke the Discoverer Web Services you must ensure that the Discoverer Web Services are installed and configured.

To verify that the Discoverer Web Services are installed and configured, you access the endpoint URL. If you cannot access the URL, contact the Discoverer manager.

Navigate to the link http://<host>:<port>/discoverer/wsi.

You should be prompted for the user/password created in the earlier steps.

Note: You can also use the user name and password of the 'weblogic' user that was entered during installation (for more information, see your middle tier administrator).

1.12.3 Setting values for Discoverer Web Services using Oracle Fusion Middleware Control

The maxSessions setting for Discoverer Web Services should be configured using Fusion Middleware Control. This setting specifies the maximum number of Discoverer sessions that can be active at the same time (the recommended value is 20)

For more information about configuring Discoverer Web Services using Fusion Middleware Control, see the Oracle Fusion Middleware Configuration Guide for Oracle Business Intelligence Discoverer.

1.12.4 Creating web service client stubs (web service proxy)

You can obtain a set of proxy/client files by generating them from a set of web service client libraries. Oracle Web Services provide libraries for this purpose. For more information, see Oracle Fusion Middleware Developer's Guide for Oracle Web Services.

To generate the Discoverer Web Service client from the Discoverer WSDL URL:

1. Display a Web browser.

2. Access the Discoverer WSDL URL: http://<host>:<port>/discoverer/wsi?wsdl
For more information, see "What is the WSDL format?", and "Writing a client application to invoke web services using generated web service client stubs".

1.12.5 Setting the Session Maintain Property

You must set the value of the SESSION_MAINTAIN_PROPERTY in the web service library. The SESSION_MAINTAIN_PROPERTY specifies whether sessions are stateful, and because Discoverer Web Services sessions are stateful, this property must be set to True as follows:

Map requestContext = ((BindingProvider)proxy).getRequestContext();
requestContext.put(BindingProvider.SESSION_MAINTAIN_PROPERTY,true);

Note: Each supported web service library has an equivalent SESSION_MAINTAIN_PROPERTY for maintaining stateful sessions. For more information, see your web service documentation.

1.12.6 Writing a client application to invoke web services using generated web service client stubs

The following code examples provide an illustration of a basic client application:

Example 1-1 Define a Java class

class webserviceclient
{
public static void main(String[] args)
{
}
}

Example 1-2 Instantiate the web service client stub

class webserviceclient
{
@WebServiceRef
private static Wsi_Service wsi_Service;
public static void main(String[] args)
{
wsi_Service = new Wsi_Service();
wsiProxy proxy = wsi_Service.getWsi();
}
}

Example 1-3 Ensure the client maintains the session

This is needed as the Discoverer web service is stateful.

class webserviceclient
{
@WebServiceRef
private static Wsi_Service wsi_Service;
public static void main(String[] args)
{
wsi_Service = new Wsi_Service();
wsiProxy proxy = wsi_Service.getWsi();
Map requestContext = ((BindingProvider)proxy).getRequestContext();
requestContext.put(BindingProvider.SESSION_MAINTAIN_PROPERTY,true);
}
}

Example 1-4 Set credentials to access the protected web service

class webserviceclient
{
@WebServiceRef
private static Wsi_Service wsi_Service;
public static void main(String[] args)
{
wsi_Service = new Wsi_Service();
wsiProxy proxy = wsi_Service.getWsi();
Map requestContext = ((BindingProvider)proxy).getRequestContext();
requestContext.put(BindingProvider.USERNAME_PROPERTY,"username");
requestContext.put(BindingProvider.PASSWORD_PROPERTY,"password");
requestContext.put(BindingProvider.SESSION_MAINTAIN_PROPERTY,true);
}
}

Example 1-5 Set the web service endpoint

class webserviceclient{    @WebServiceRef    private static Wsi_Service wsi_Service;    public static void main(String[] args)
{
wsi_Service = new Wsi_Service();
wsiProxy proxy = wsi_Service.getWsi();
Map requestContext = ((BindingProvider)proxy).getRequestContext();
requestContext.put(BindingProvider.USERNAME_PROPERTY,"username");
requestContext.put(BindingProvider.PASSWORD_PROPERTY,"password");
requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY,"http://host:port/discoverer/wsi");
requestContext.put(BindingProvider.SESSION_MAINTAIN_PROPERTY,true);
}}

Example 1-6 Perform any web service operations on the stub

class webserviceclient{
@WebServiceRef
private static Wsi_Service wsi_Service;f
public static void main(String[] args)
{
wsi_Service = new Wsi_Service();
wsiProxy proxy = wsi_Service.getWsi();
Map requestContext = ((BindingProvider)proxy).getRequestContext();
requestContext.put(BindingProvider.USERNAME_PROPERTY,"username");
requestContext.put(BindingProvider.PASSWORD_PROPERTY,"password");
requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY,"http://host:port/discoverer/wsi");
requestContext.put(BindingProvider.SESSION_MAINTAIN_PROPERTY,true);

DisplayName displayname = new DisplayName();
displayname.setUser("DISPLAYNAME");
Identifier idfr = new Identifier() ;
idfr.setId("IDENTIFIER");

UserCredential uc = new UserCredential();
uc.setDisplayName(displayname);
uc.setIdentifier(idfr);

LocaleBean locale = new LocaleBean();
locale.setCountry("US");
locale.setLanguage("en");
locale.setVariant("");

SessionKey sKey = proxy.login(uc, locale);
proxy.logout(sKey);
}}

Note: To compile the above client application, the web service libraries must be set in the classpath. When using the Oracle libraries, soap.jar, Http_client.jar and the downloaded proxy.jar must be present. For example, if you run the client application from the command prompt, you might set the Java classpath as follows:

set CLASSPATH=<absolute path of>/proxy.jar;<absolute path of>\soap.jar;<absolute path of>\Http_client.jar

Note: If you use an integrated development environment such as Oracle JDeveloper or Eclipse, then set the Java classpath using the user interface for that environment

1.13 What is a typical flow of events for accessing Discoverer Web Services API to return results?

The Discoverer Web Services API can be used by a client application to obtain XML data related to Discoverer connections and worksheets. A typical flow of events is suggested in the following flow (for more information, see "Typical flow of events: Detailed task examples"):

Typical flow of events

1. "Provide the credentials to invoke Discoverer Web Services"

2. "Use the identifier to invoke login()"
This starts a user session and provides a valid session key.

Note:
Oracle E-Business Suite users must use the AppConnect() API to generate the session key. For more information, see "Secure Access to Discoverer Web Services for Oracle E-Business Suite Users".

3. "Inspect the connection information by invoking getConnectionList()"
This returns a list of connections for clients to use for display and selection.

4. "Select a particular connection and invoke getFolderEntryList()"
This returns a list of workbooks for user display and selection.

In case of OLAP connections there can be folders along with workbooks.

5. "Select a particular worksheet by invoking getWorksheetList()"
This returns just a list of worksheets with empty parameter information.

6. "Get the layout of the worksheet by invoking getLayoutMetadata()"

7. "Select the parameter metadata for a worksheet by invoking getParameterMetadata()"

8. "Select a worksheet parameter and obtain its LOVs by invoking getParameterValueList()"
This returns the LOV data in chunks which is used by clients for user display and selection.

Alternatively, you can select worksheet parameters in the cascading style by invoking the getCascadeParameterValueList(). For more information see "Select worksheet parameters and obtain LOVs in the cascading style by invoking getCascadeParameterValueList()".

Note: If the worksheet does not contain parameters, then the client should not invoke getParameterValueList() or getCascadeParameterValueList().

9. "Submit a worksheet query (including parameters) by invoking submitWorksheetQuery()"
The client performs a submit, passing parameters if required.

A queryKey is obtained when a worksheet query request is submitted.

10. "Check the status of the query by invoking getQueryStatus()"
This returns the current status of the query for user display and selection.

11. "View worksheet data on completion of the query by invoking getWorksheetData()"

12. "Log out, by invoking Logout()"

Note: Queries must be executed sequentially, so that when the client application performs a single login call for a user, it must ensure that the query submission for a worksheet is made only after the previous query submission has yielded results.

Note: For OLAP worksheets, the XML can contain aggregate totals. In that case, if the API client creates a total for an OLAP worksheet with Aggregate totals, it would yield wrong results.

1.14 Typical flow of events: Detailed task examples

The following flow of events shows some typical Java class entries for each task example.

1.14.1 Provide the credentials to invoke Discoverer Web Services

The following code must be executed before you can successfully perform a login() API call.

wsi_Service = new Wsi_Service();
Wsi proxy = wsi_Service.getWsi();
Map requestContext = ((BindingProvider)proxy).getRequestContext();
requestContext.put(BindingProvider.USERNAME_PROPERTY,"weblogic");
requestContext.put(BindingProvider.PASSWORD_PROPERTY,"weblogic");
requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY,testEndpoint);
requestContext.put(BindingProvider.SESSION_MAINTAIN_PROPERTY,true);

1.14.2 Use the identifier to invoke login()

You must provide the user credentials to invoke the Discoverer Web Services before you can use the login() call. For more information, see "Provide the credentials to invoke Discoverer Web Services".

Note: The login() call must be invoked before invoking any other Discoverer Web Services.

DisplayName displayname = new DisplayName();
displayname.setUser("DISPLAYNAME");
Identifier idfr = new Identifier() ;
idfr.setId("IDENTIFIER");

UserCredential uc = new UserCredential();
uc.setDisplayName(displayname);
uc.setIdentifier(idfr);

LocaleBean locale = new LocaleBean();
locale.setCountry("US");
locale.setLanguage("en");
locale.setVariant("");

System.out.println("Invoke the login() WS API");
SessionKey sKey = proxy.login(uc, locale);
System.out.println("Session Key :"+sKey.getKey());

Note: To access SSO-based connections, you can provide the GUID and SSOUsername as the Identifier and DisplayName respectively.

1.14.3 Secure Access to Discoverer Web Services for Oracle E-Business Suite Users

Instead of using the login() API, Oracle E-Business Suite users can provide the secure ticket and connection details using the AppsConnect() API and access Discoverer Worksheets.

Notes:

- Oracle E-Business Suite users cannot use Single Sign-On (SSO) or Oracle Access Manager (OAM) authentication. For more information about how to enable and disable SSO or OAM for Discoverer, see Oracle Fusion Middleware Configuration Guide for Oracle Business Intelligence Discoverer.

- The AppsConnect() call must be invoked before invoking any other Discoverer Web Services.

LocaleBean locale = new LocaleBean();
locale.setCountry("US");
locale.setLanguage("en");
locale.setVariant("");

public SessionKey AppsConnect
(
Ticket ticket,
ConnectString connectStr,
DiscoEulName eul,
LocaleBean aLocale
)
throws DiscovererWSException, DiscovererSessionUnavailableException

System.out.println("Invoke the AppsConnect() WS API");
SessionKey sKey = AppsConnect(ticket,ConnectStr,eul,locale);
System.out.println("Session Key :"+sKey.getKey());

In the AppsConnect() API, Ticket, ConnectString, and DiscoEulName are string wrapper objects. Values for these objects can be retrieved from the Discoverer URL that Discoverer users use to start Discoverer.

A sample Discoverer Viewer URL is given below:

http://hostname.domain/discoverer/viewer?Connect=[APPS_SECURE]discor11&SessionCookieName=discor11&eul=EUL_US&opendbid=HRIPWCMP&FrameDisplayStyle=separate&acf=453560870&NLS_LANG=AMERICAN_AMERICA&NLS_DATE_FORMAT=DD-MON-RRRR&NLS_NUMERIC_CHARACTERS=.,&NLS_DATE_LANGUAGE=AMERICAN&NLS_SORT=BINARY&exitURL=http://hostname.domain/OA_HTML/OA.jsp?OAFunc=OAHOMEPAGE

The value of the SessionCookeName parameter is the value that you pass for the Ticket object.

The value of the Connect parameter is the value that you pass for the ConnectString object. In the above URL, it is [APPS_SECURE]discor11.

The value of the eul parameter is the value that you pass for the DiscoEulName object. In the above URL, it is EUL_US.

The locale details can either be defined using the LocaleBean object or retrieved from the URL.

The acf parameter identifies the user/responsibility/security group. Any change in this parameter results in a new Discoverer session.

1.14.4 Inspect the connection information by invoking getConnectionList()

Once logged in, the user can invoke the getConnectionList() API to obtain a list of available connections as shown below:

System.out.println("Invoke the getConnectionList() API");
ConnectionList cl = proxy.getConnectionList(sKey);
List conns = cl.getConnections();
System.out.println("Discoverer connections:");
for(int i=0; i<conns.size(); i++)
{
System.out.println("Name:"+conns.get(i).getConnectionName().getName());
System.out.println(" Key:"+ conns.get(i).getConnectionKey().getKey());
System.out.println(" Desc:"+ conns.get(i).getConnectionDesc().getDesc());
}

1.14.5 Select a particular connection and invoke getFolderEntryList()

Before you can use the getFolderEntryList() API, you must provide credentials to invoke the Discoverer Web Services, and have a valid session key (by performing a login() call). For more information, see "Provide the credentials to invoke Discoverer Web Services", and "Use the identifier to invoke login()".

Note:
Oracle E-Business Suite users must use the AppsConnect() API to generate the session key. After connecting to Discoverer using AppsConnect(), for invoking the getFolderEntryList() API, you can pass a NULL value for the ConnectionKey.

ConnectionKey cKey = new ConnectionKey();
cKey.setKey("CONNECTIONKEY");
FolderEntryPath fPath = new FolderEntryPath();
fPath.setPath("");

System.out.println("Invoke the getFolderEntryList() API");
FolderEntryList fList = proxy.getFolderEntryList(sKey, cKey, fPath);
List fEntries = fList.getFolderEntries();
for(int i=0; i<fEntries.size(); i++)
{
System.out.println("Name:"+ fEntries.get(i).getName().getName());
System.out.println(" Path:"+ fEntries.get(i).getPath().getPath());
System.out.println("    Desc:"+fEntries.get(i).getDesc().getDesc());
System.out.println("       Type:"+ fEntries.get(i).getType().getType());
}

Notes:

- The folder path is an empty string for relational database connections. For OLAP connections you can specify the complete folder name.

- For a relational database connection, the Type is always "Workbook". In case of an OLAP connection, you can see "Folder" as Type.

1.14.6 Select a particular worksheet by invoking getWorksheetList()

You can use the getWorksheetList() API to get a list of worksheets for a given workbook.

Note:
Oracle E-Business Suite users do not require to create a ConnectionKey as they connect to Discoverer using the AppsConnect() API. After connecting to Discoverer, for invoking the getWorksheetList() API, the ConnectionKey associated with the workbook can be passed as NULL or an empty string.

WorkbookKey wbKey = new WorkbookKey();
wbKey.setConnKey(cKey);
wbKey.setKey("ANALYTIC_FUNCTION_EXAMPLES");

System.out.println("Invoke the getWorksheetList() API");
WorksheetList wsList = proxy.getWorksheetList(sKey, wbKey);
List wsheets = wsList.getWorksheets();
for(int i=0; i<wsheets.size(); i++)
{
System.out.println("Name:" +wsheets.get(i).getName().getName());
System.out.println("    Key:"+wsheets.get(i).getKey().getKey());
}

The Key that you obtained from the above call can be used as the worksheet key for the subsequent web service calls.

1.14.7 Get the layout of the worksheet by invoking getLayoutMetadata()

This API provides information about the dimensions of a Discoverer worksheet.

WorksheetKey wsKey = new WorksheetKey();
wsKey.setWbKey(wbKey);
wsKey.setKey("ANALYTIC_FUNCTION_EXAMPLES/1817");

System.out.println("Invoke the getLayoutMetadata() API");
Layout layout = proxy.getLayoutMetadata(sKey, wsKey);
List dimensions = layout.getDimensions();
List measures = layout.getMeasures();
for(int i=0; i< dimensions.size(); i++)
{
System.out.println("Dimension :"+dimensions.get(i).getName());
}
for(int i=0; i<measures.size(); i++)
{
System.out.println("Measure :"+measures.get(i).getName());
}

1.14.8 Select the parameter metadata for a worksheet by invoking getParameterMetadata()

Use this API to check whether any parameter metadata is available for the worksheet.

System.out.println("Invoke the getParameterMetaData() API");
ParameterList pList = proxy.getParameterMetadata(sKey, wsKey);
List parameters = pList.getParameters();
for(int i=0; i< parameters.size(); i++)
{
System.out.println("Name:"+ parameters.get(i).getName().getName());
System.out.println("  Key:"+parameters.get(i).getKey().getKey());
}

This API returns an empty list if the worksheet does not contain any parameter.

1.14.9 Select a worksheet parameter and obtain its LOVs by invoking getParameterValueList()

The parameters for this API are sessionKey, parameterKey, and an integer.

ParameterKey pKey = new ParameterKey();
pKey.setKey("ANALYTIC_FUNCTION_EXAMPLES/1817/36211");
pKey.setWsKey( wsKey);
ParameterValueList pvList = proxy.getParameterValueList(sKey,pKey,new Integer(50));
List pvs = pvList.getParamValues();
System.out.println("Invoke the getParameterValueList() API");
System.out.println("Parameter Lovs:");
for(int i=0; i< pvs.size(); i++)
{
System.out.println("Val :"+pvs.get(i).getValue()); // Lov
System.out.println(" DescriptorKey :"+pvs.get(i).getDescriptorKey());
//paramter descriptor key. This is valid if the parameter is an indexed type;
}

1.14.10 Select worksheet parameters and obtain LOVs in the cascading style by invoking getCascadeParameterValueList()

The parameters for this API are sessionKey, parameterKey, an integer, and ParameterSelectList.

// Code to retrieve cities from the region 'west'.
// To build the ParameterSelectList with the region as "west"

ParameterValue[] pval_region = new ParameterValue[1];
pval_region[0] = new ParameterValue();
pval_region[0].setValue("West");
pval_region[0].setDescriptorKey(null);

ParameterSelect[] pselect_region = new ParameterSelect[1];
pselect_region[0] = new ParameterSelect();
pselect_region[0].setKey(pKey_region);
ArrayList<ParameterValue> pval_regionlist = new ArrayList<ParameterValue>();
pval_regionlist.add(pval_region[0]);
pselect_region[0].getValues().addAll(pval_regionlist);

ParameterSelectList pselectList= new ParameterSelectList();
ArrayList<ParameterSelect> pSelectArraylist = new ArrayList<ParameterSelect>();
pSelectArraylist.add(pselect_region[0]);
pselectList.getSelParams().addAll(pSelectArraylist);

// To get the values for the city parameter
ParameterKey pKey_city = new ParameterKey();
pKey_city.setKey("XMLP_PARAMETERSCASCADE/1/10");
pKey_city.setWsKey(wsKey);

do
{

pvList = proxy.getCascadeParameterValueList(sKey,pKey_city,new Integer(10),pselectList);
pvs= pvList.getParamValues();
System.out.println("Invoke the getParameterValueList() API");
System.out.println("Parameter Lovs: "+pvs.size());
for(int i=0; i< pvs.size(); i++)
{
System.out.println("Val :"+pvs.get(i).getValue()); // Lov
System.out.println("    DescriptorKey :"+pvs.get(i).getDescriptorKey());
}
}while (pvs.size()>0 );

1.14.11 Submit a worksheet query (including parameters) by invoking submitWorksheetQuery()

The parameters for this API are sessionKey, workSheetKey, ParameterSelectList and QueryOption.

ParameterSelectList helps you to pass a list of selected parameters. The code below is for multiple parameters and multiple vales for each parameter.

ParameterValue[] pval = new ParameterValue[1];
pval[0] = new ParameterValue();
pval[0].setValue("Aladdin");
pval[0].setDescriptorKey(null);
pval[1] = new ParameterValue();
pval[1].setValue("A Few Good Men");
pval[1].setDescriptorKey(null);

ParameterSelect[] pselect = new ParameterSelect[1];
pselect[0] = new ParameterSelect();
pselect[0].setKey(pKey);
ArrayList pvallist = new ArrayList();
pvallist.add(pval[0]);
pvallist.add(pval[1]);
pselect[0].getValues().addAll(pvallist);
ParameterSelectList pselectList = new ParameterSelectList();
ArrayList pselectlist = new ArrayList();
pselectlist.add(pselect[0]);
pselectList.getSelParams().addAll(pselectlist);

The QueryOption helps you to control the properties of the result set. The supported result types are XMLROWSET, PDF, HTML, and XLS. For the XMLROWSET type, you can specify the number of rows per fetch.

From the QueryOptions that you specify, the applicable options are considered; the others are discarded.

ResultType rt = new ResultType();
rt.setType("XMLROWSET");

QueryOption qo = new QueryOption();
qo.setChunkSize(1021);
qo.setNoOfrows(25);
qo.setResultType(rt);
qo.setUserCredential(uc);

The code below submits the query.

QueryKey qKey = proxy.submitWorksheetQuery(sKey, wsKey,pselectList,qo);
System.out.println("Query Key :" + qKey.getKey());

1.14.12 Check the status of the query by invoking getQueryStatus()

String status="";
String resultsReady = "Results Ready";
String cancelled = "Cancelled";
QueryStatus qs = null;
while(!status.equalsIgnoreCase(resultsReady) &&
!status.equalsIgnoreCase(cancelled))
{ qs = proxy.getQueryStatus(sKey, qKey);
status = qs.getStatus();
System.out.println("Status :"+qs.getStatus());
Thread.sleep(5);
}

1.14.13 View worksheet data on completion of the query by invoking getWorksheetData()

Once you get the query status as Ready, you can get the worksheet data using the getWorksheetData() API. The code below shows how to get the worksheet data for XMLROWSET result type.

if(qs!= null && qs.getStatus().equalsIgnoreCase(resultsReady))
{
System.out.println("Invoking getWorksheetData() API");
QueryResult qr = null;
do
{
qr = proxy.getWorksheetData(sKey, qKey,false);
String data = qr.getData();
if (qo.getResultType().getType().matches("XMLROWSET") )
{
System.out.println("------------Data block begin------------");
System.out.println(data);
System.out.println("------------Data block end------------");
}
}while(qr.isFinished()== false);
}

The following code sample explains how to get the worksheet data for a binary data type (for example, XLS).

if(qs!= null && qs.getStatus().equalsIgnoreCase(resultsReady))
{
System.out.println("Invoking getWorksheetData() API");
QueryResult qr = null;
do
{
qr = proxy.getWorksheetData(sKey, qKey,false);
String data = qr.getData();
if(qo.getResultType().getType().matches("XLS") )
{
String opFilename = "/tmp/out.xls" ;
else if
Base64Decoder myBase64Decoder = new Base64Decoder();
byte _myTempByteArray [] = null;
FileOutputStream fout = null;
String opFilename = "/tmp/out.xls" ;
try
{
fout =new FileOutputStream(opFilename);
}
catch(FileNotFoundException e)
{
System.out.println("Error Opening Output File");
return;
}
_myTempByteArray = myBase64Decoder.decode(data);
fout.write(_myTempByteArray);
}
}while(qr.isFinished()== false);
}

1.14.14 Log out, by invoking Logout()

proxy.logout(sKey);

1.15 Example of a Java class that invokes Discoverer Web Services

The following text is an example of a Java class (wsiClient.java) that might invoke Discoverer Web Services:

import java.io.FileNotFoundException;
import java.io.FileOutputStream;

import java.util.List;
import java.util.Map;

import javax.xml.ws.BindingProvider;
import javax.xml.ws.WebServiceRef;

import jaxwstest.proxy.Wsi;
import jaxwstest.proxy.Wsi_Service;
import jaxwstest.proxy.types.ConnectionKey;
import jaxwstest.proxy.types.ConnectionList;
import jaxwstest.proxy.types.DisplayName;
import jaxwstest.proxy.types.FolderEntry;
import jaxwstest.proxy.types.FolderEntryList;
import jaxwstest.proxy.types.FolderEntryPath;
import jaxwstest.proxy.types.Identifier;
import jaxwstest.proxy.types.LocaleBean;
import jaxwstest.proxy.types.QueryKey;
import jaxwstest.proxy.types.QueryOption;
import jaxwstest.proxy.types.QueryResult;
import jaxwstest.proxy.types.QueryStatus;
import jaxwstest.proxy.types.ResultType;
import jaxwstest.proxy.types.SessionKey;
import jaxwstest.proxy.types.UserCredential;
import jaxwstest.proxy.types.WorkbookKey;
import jaxwstest.proxy.types.Worksheet;
import jaxwstest.proxy.types.WorksheetKey;
import jaxwstest.proxy.types.WorksheetList;

import oracle.net.www.Base64Decoder;

public class wsiClient
{
@WebServiceRef
private static Wsi_Service wsi_Service;
public static void main(String[] args)
{

try
{
// Create a new stub
wsi_Service = new Wsi_Service();
wsiProxy proxy = new wsiProxy();

Map requestContext = ((BindingProvider)proxy).getRequestContext();
requestContext.put(BindingProvider.USERNAME_PROPERTY,"weblogic");
requestContext.put(BindingProvider.PASSWORD_PROPERTY,"weblogic");
requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY,testEndpoint);
requestContext.put(BindingProvider.SESSION_MAINTAIN_PROPERTY,true);
// Add your code to call the desired methods

String version = proxy.getVersion();
System.out.println("Version ="+version );

DisplayName ssouser = new DisplayName();
ssouser.setUser("SSOUSER1");
Identifier  idfr = new Identifier();
idfr.setId("IDENTIFIER");

UserCredential uc = new UserCredential();
uc.setDisplayName(ssouser);
uc.setIdentifier(idfr);
LocaleBean locale = new LocaleBean();
locale.setCountry("US");
locale.setLanguage("en");
locale.setVariant("");

System.out.println("Invoke the login() WS API");
SessionKey sKey = proxy.login(uc, locale);
System.out.println("Session Key :"+sKey.getKey());

System.out.println("-----------------------------------------------");
// Get the list of connections accessible to this SSOUser
System.out.println("Invoke the getConnectionList() API");
ConnectionList cl = proxy.getConnectionList(sKey);
List conns = cl.getConnections();
System.out.println("Discoverer connections:");
for(int i=0; i<conns.size(); i++)
{
System.out.println("Name:"+conns.get(i).getConnectionName().getName());
System.out.println(" Key:"+ conns.get(i).getConnectionKey().getKey());
System.out.println(" Desc:"+ conns.get(i).getConnectionDesc().getDesc());
}
System.out.println("-----------------------------------------------");

System.out.println("Invoke the getFolderEntryList() API");
// Create a valid connectionKey object using one of the connection keys obtained
in the getConnectionList
ConnectionKey cKey = new ConnectionKey();
cKey.setKey("CONNECTIONKEY");
FolderEntryPath fPath = new FolderEntryPath();
fPath.setPath("");

System.out.println("Invoke the getFolderEntryList() API");
FolderEntryList fList = proxy.getFolderEntryList(sKey, cKey, fPath);
List fEntries = fList.getFolderEntries();
for(int i=0; i<fEntries.size(); i++)
{
System.out.println("Name:"+ fEntries.get(i).getName().getName());
System.out.println("   Path:"+ fEntries.get(i).getPath().getPath());
System.out.println("   Desc:"+fEntries.get(i).getDesc().getDesc());
System.out.println("   Type:"+ fEntries.get(i).getType().getType());
}
System.out.println("-----------------------------------------------");

WorkbookKey wbKey = new WorkbookKey();
wbKey.setConnKey(cKey);
wbKey.setKey("ANALYTIC_FUNCTION_EXAMPLES");

System.out.println("Invoke the getWorksheetList() API");
WorksheetList wsList = proxy.getWorksheetList(sKey, wbKey);
List wsheets = wsList.getWorksheets();
for(int i=0; i<wsheets.size(); i++)
{
System.out.println("Name:" +wsheets.get(i).getName().getName());
System.out.println("    Key:"+wsheets.get(i).getKey().getKey());
}
System.out.println("-----------------------------------------------");

WorksheetKey wsKey = new WorksheetKey();
wsKey.setWbKey(wbKey);
wsKey.setKey("ANALYTIC_FUNCTION_EXAMPLES/1817");

System.out.println("Invoke the getLayoutMetadata() API");
Layout layout = proxy.getLayoutMetadata(sKey, wsKey);
List dimensions = layout.getDimensions();
List measures = layout.getMeasures();
for(int i=0; i< dimensions.size(); i++)
{
System.out.println("Dimension :"+dimensions.get(i).getName());
}
for(int i=0; i<measures.size(); i++)
{
System.out.println("Measure :"+measures.get(i).getName());
}

System.out.println("-----------------------------------------------");

System.out.println("Invoke the getParameterMetaData() API");
ParameterList pList = proxy.getParameterMetadata(sKey, wsKey);
List parameters = pList.getParameters();
for(int i=0; i< parameters.size(); i++)
{
System.out.println("Name:"+ parameters.get(i).getName().getName());
System.out.println("  Key:"+parameters.get(i).getKey().getKey());
}
System.out.println("-----------------------------------------------");

ParameterKey pKey = new ParameterKey();
pKey.setKey("ANALYTIC_FUNCTION_EXAMPLES/1817/36211");
pKey.setWsKey( wsKey);

ParameterValueList pvList = proxy.getParameterValueList(sKey,pKey,new Integer(50));
List pvs = pvList.getParamValues();
System.out.println("Invoke the getParameterValueList() API");
System.out.println("Parameter Lovs:");
for(int i=0; i< pvs.size(); i++)
{
System.out.println("Val :"+pvs.get(i).getValue()); // Lov
System.out.println(" DescriptorKey :"+pvs.get(i).getDescriptorKey());
//paramter descriptor key. This is valid if the parameter is an indexed type;
}

ParameterValue[] pval = new ParameterValue[1];
pval[0] = new ParameterValue();
pval[0].setValue("Aladdin");     pval[0].setDescriptorKey(null);
pval[1] = new ParameterValue();
pval[1].setValue("A Few Good Men");
pval[1].setDescriptorKey(null);

ParameterSelect[] pselect = new ParameterSelect[1];
pselect[0] = new ParameterSelect();
pselect[0].setKey(pKey);
ArrayList pvallist = new ArrayList();
pvallist.add(pval[0]);
pvallist.add(pval[1]);
pselect[0].getValues().addAll(pvallist);
ParameterSelectList pselectList = new ParameterSelectList();
ArrayList pselectlist = new ArrayList();
pselectlist.add(pselect[0]);
pselectList.getSelParams().addAll(pselectlist);

ResultType rt = new ResultType();
rt.setType("XMLROWSET");

QueryOption qo = new QueryOption();
qo.setChunkSize(1021);
qo.setNoOfrows(25);
qo.setResultType(rt);
qo.setUserCredential(uc);

QueryKey qKey = proxy.submitWorksheetQuery(sKey, wsKey,pselectList,qo);
System.out.println("Query Key :" + qKey.getKey());

String status="";
String resultsReady = "Results Ready";
String cancelled = "Cancelled";
QueryStatus qs = null;
while(!status.equalsIgnoreCase(resultsReady) &&
!status.equalsIgnoreCase(cancelled))
{
qs = proxy.getQueryStatus(sKey, qKey);
status = qs.getStatus();
System.out.println("Status :"+qs.getStatus());
Thread.sleep(5);
}
if(qs!= null && qs.getStatus().equalsIgnoreCase(resultsReady))
{
System.out.println("Invoking getWorksheetData() API");
QueryResult qr = null;
do
{
qr = proxy.getWorksheetData(sKey, qKey,false);
String data = qr.getData();
if (qo.getResultType().getType().matches("XMLROWSET") )
{
System.out.println("------------Data block begin------------");
System.out.println(data);
System.out.println("------------Data block end------------");
}
}while(qr.isFinished()== false);
}
proxy.logout(sKey);
}
catch(Exception ex){
ex.printStackTrace();
}
}
}

2 Discoverer Web Services API Reference

This chapter provides detailed reference information for the following Discoverer Web Services API.

- "AppsConnect"

- "getConnectionList"

- "getFolderEntryList"

- "getLayoutMetaData"

- "getParameterMetaData"

- "getParameterValueList"

- "getCascadeParameterValueList"

- "getQueryStatus"

- "getVersion"

- "getViewerURL"

- "getWorksheetData"

- "getWorkSheetList"

- "isSessionValid"

- "login"

- "logout"

- "requestQueryCancel"

- "submitWorksheetQuery"

2.1 AppsConnect

This API is used to establish a secure connection to Discoverer Web Services for Oracle E-Business Suite (EBS) users.

This API call accepts the APP_SECURE ticket, Connection string, name of the EUL, and LocaleBean information and returns a unique SessionKey, which is then passed to all other API calls.

API

Details

Method

Public SessionKey AppsConnect(ticket,ConnectStr,eul,locale) { }

Input:

- ticket
This object must contain a valid APP_SECURE ticket for the Discoverer application.

- ConnectStr
This object passes the connection details to connect to Discoverer.

- eul
Specifies the name of the database schema which contains the EUL that the user want to connect to.

- locale
This object passes locale information to the webservice session. By default the Locale is English (en-US).

Output

- SessionKey

Exceptions

- DiscovererWSException

- DiscovererSessionUnavailableException

The following table lists the fields of the structures.

Structure

Fields

Ticket

- String ticket_name

ConnectString

- String name

DiscoEulName

- String eulname

LocaleBean

- String language

- String country

- String variant

2.2 getConnectionList

This API call obtains a list of connections. It accepts SessionKey and returns the Connection list object. In single sign-on mode the list of public connections and private connections is returned. The connection can be of type Relational, OLAP, or APPS.

API

Details

Method

Public ConnectionList getConnectionList(SessionKey aSessionKey) { }

Input:

- SessionKey

Output

- ConnectionList

Exceptions

- java.rmi.RemoteException

The following table lists the fields of the structures.

Structure

Fields

ConnectionList

- Array of Connection objects

Connection

- ConnectionName

- ConnectionKey

- ConnectionDescription

- ConnectionEUL

- ConnectionDBIdentifier

- ConnectionAccessType

ConnectionName

- String name

ConnectionKey

- String key

ConnectionDescription

- String description

ConnectionEUL

- String eulname

ConnectionDBIdentifier

- String database name

ConnectionAccessType

- String accesstype

2.3 getFolderEntryList

This API call uses a connection to obtain the list of non-scheduled workbooks and FolderEntries. It accepts SessionKey, ConnectionKey, and FolderEntrypath and provides a list of non-scheduled workbooks and FolderEntries data that is accessible from the connection for the FolderEntrypath. The list of non-scheduled workbooks includes all of the shared workbooks for the database user that was used in the connection.

When the connection is to relational data, workbooks are stored in a single level in the EUL. The only valid value for FolderEntrypath is “”. An empty string specifies the root folder entry in both Discoverer Plus Relational and Discoverer Plus OLAP.

When the connection is to OLAP data, FolderEntries and Workbooks are stored in the Discoverer Catalog. There can be multiple levels of FolderEntries, which can be queried by providing the appropriate FolderEntryPath. Clients must make successive calls to this method to browse FolderEntries.

API

Details

Method

Public FolderEntryList getFolderEntryList(SessionKey aSessionKey,
ConnectionKey aCkey, FolderEntrypath fpath ) { }

Input:

- SessionKey

- ConnectionKey

- FolderEntryPath
Path under which Workbooks and FolderEntries are required.

Output

- FolderEntryList object

Exceptions

- java.rmi.RemoteException

The following table lists the fields of the structures.

Structure

Fields

FolderEntryList

- Array of FolderEntry objects

- String country

- String variant

FolderEntry

- FolderEntryName

- FolderEntrypath
Fully qualified path to either the FolderEntry or the WorkbookEntry.

- FolderEntryType

- FolderEntryDescription

FolderEntryName

- String name

FolderEntryPath

- String path

FolderEntryDescription

- String description

FolderEntryType

- String type
Either FolderEntry or WorkbookEntry.

- WorkbookKey
Valid if the type is WorkbookEntry.

WorkbookKey

- String wbDevKey

- ConnectionKey

2.4 getLayoutMetaData

This API call obtains the layout metadata for a selected worksheet. It accepts SessionKey and WorksheetKey, and it provides the Layout information for the worksheet that is identified by WorksheetKey.

API

Details

Method

Public Layout getLayoutMetaData(SessionKey aSessionKey,
WorksheetKey  aWorksheetKey ) {}

Input:

- SessionKey

- WorksheetKey

Output

- Layout

Exceptions

- java.rmi.RemoteException

The following table lists the fields of the structures.

Structure

Fields

Layout

- Array of Dimension objects

- Array of Measure objects

Dimension

- String label

Measure

- String label

2.5 getParameterMetaData

This API call obtains the parameter metadata for a selected worksheet. It accepts SessionKey and WorksheetKey and provides the list of parameters for the specified worksheet that is identified by WorksheetKey

API

Details

Method

Public ParameterList getParameterMetaData(SessionKey aSessionKey,
WorksheetKey  aWorksheetKey ) {}

Input:

- SessionKey

- WorksheetKey

Output

- ParameterList

Exceptions

- java.rmi.RemoteException

The following table lists the fields of the structures.

Structure

Fields

ParameterList

- Array of Parameter objects.

2.6 getParameterValueList

This API call obtains the parameter LOVs using a ParameterKey. It accepts SessionKey, ParameterKey, and numValues and provides the list of values (LOVs). You call this method for parameters that have LOVs. The LOVs are retrieved in chunks (the size is specified by numValues), and you can page through from start to finish in one direction only; there is no bi-directional paging support of parameters. The client application is responsible for caching the parameters.

API

Details

Method

Public ParameterValueList getParameterValueList(SessionKey
aSessionKey, ParameterKey aParamKey, int numValues){ }

Input:

- SessionKey

- ParameterKey

- numValues
An integer value that specifies the number of values that the web service should return in one call. If there are more values getParameterValueList should be called repeatedly.

Output

- ParameterValueList

Exceptions

- java.rmi.RemoteException

Notes

- Parameter linking is inactive.

The following table lists the fields of the structures.

Structure

Fields

ParameterValueList

- Array of ParameterValue Objects

- Boolean finished

2.7 getCascadeParameterValueList

This API call obtains the parameter LOVs using a ParameterKey and ParameterSelectList. It accepts SessionKey, ParameterKey, numValues, and ParameterSelectList and provides the list of values (LOVs) in the cascading style. In cascading parameters, the LOVs of one parameter depends on the value selected for the preceding parameter in the worksheet. The LOVs are retrieved in chunks (the size is specified by numValues), and you can page through from start to finish in one direction only; there is no bi-directional paging support of parameters. The client application is responsible for caching the parameters.

API

Details

Method

Public ParameterValueList getCascadeParameterValueList(SessionKey
aSessionKey, ParameterKey aParamKey, int numValues, ParameterSelectList pselectList){ }

Input:

- SessionKey

- ParameterKey

- numValues
An integer value that specifies the number of values that the web service should return in one call. If there are more values getCascadeParameterValueList should be called repeatedly.

- ParameterSelectList

Output

ParameterValueList

Exceptions

- DiscovererWSException

- DiscovererSessionUnavailableException

- DiscovererSessionCreationFailedException

The following table lists the fields of the structures.

Structure

Fields

ParameterValueList

- Array of ParameterValue Objects

- Boolean finished

2.8 getQueryStatus

This API call returns the status of the query, such as executing or canceled. It accepts SessionKey and QueryKey.

API

Details

Method

Public QueryStatus getQueryStatus(SessionKey aSessionKey,
QueryKey aQueryKey){ }

Input:

- SessionKey

- QueryKey

Output

- QueryStatus

Exceptions

- java.rmi.RemoteException

The following table lists the fields of the structures.

Structure

Fields

QueryStatus

- String detail

- String status

Status is one of the following:

- QUERY_FAILED

- QUERY_EXECUTING

- QUERY_CANCELED

- QUERY_RESULTS_READY

- QUERY_NEEDS_EXECUTING

- QUERY_NOT_DEFINED

- QUERY_SCHEDULED

- QUERY_VALIDATING

2.9 getVersion

This API call provides the web service component version. Any change in the web service interface or API causes the version number to change. Use the version number to assist you in determining the functionality that is available for the web service.

API

Details

Method

Public String getVersion( ) { }

Input:

- Void

Output

- String

A version of 1.0 implies support for integration with Oracle BI Publisher.

A version of 2.0 implies support for integration with Oracle BI Publisher and interoperability with Oracle BI Enterprise Edition.

Exceptions

- None

2.10 getViewerURL

This API call provides the URL of the Discoverer Viewer instance that is hosted on the same machine as the web service. This URL can be used by clients to launch Discoverer Viewer from within their application.

API

Details

Method

Public String getViewerURL(SessionKey aSessionKey,
WorksheetKey aWorksheetkey, List aParameteSelectList){ }

Input:

- SessionKey

- WorksheetKey

- Java.util.List of ParameterSelect

Output

- String
URL to launch Discoverer Viewer.

Exceptions

- java.rmi.RemoteException

2.11 getWorksheetData

This API call accepts SessionKey and QueryKey and provides the worksheet data in the format type that is specified in QueryOption in the submitWorksheetQuery method. If the result set is large and is Rowset XML, then by default, 25 rows of data are returned. For other format types, 1MB of data is returned. You can page through the remaining data by calling this method repeatedly. If the finished flag in QueryResults is false , then call the method again to continue paging through the data. You can page through from start to finish in one direction only; there is no bi-directional paging support.

API

Details

Method

Public QueryResult getWorksheetData(SessionKey aSessionKey,
QueryKey aQueryKey){ }

Input:

- SessionKey

- QueryKey

Output

- QueryResult

Exceptions

- java.rmi.RemoteException

The following table lists the fields of the structures.

Structure

Fields

QueryResult

- String data
Rowset XML, HTML, PDF, XLS data. HTML, PDF, XLS data uses base64 encoding.

- Boolean finished
If finished is true, then do not call GetWorksheetData.

The following table describes the export types.

Export type

Relational

OLAP

HTML

HTML file is zipped and base64 encoded before transfer.

HTML file is zipped and base64 encoded before transfer.

PDF

PDF file is base64 encoded before transfer.

PDF file is base64 encoded before transfer.

XLS

XLS file is base64 encoded before transfer. Similar to Discoverer Viewer, graphs are not exported.

XLS file is zipped in base64 encoded before transfer. Graphs are exported.

For HTML, PDF, and XLS export types

- If the worksheet does not have page items, then all the data is exported.

- If the worksheet has page items, the output is different for OLAP and Relational connections as follows:

- For Relational connections:
HTML, PDF, and XLS export types - Returns worksheet data for the page items selected in the worksheet.

- For OLAP connections:
XLS export types - Returns worksheet data for all combination of page item values.

HTML or PDF export types - Returns worksheet data for the selected page item.

This export behavior is similar to Viewer with the exception that the "isCurrentPageItemsExportForOLAP" setting in the configuration.xml file is not respected.

Sample Rowset XML structure

<BIData>
<Query id="1">
<PAGE>
<ROWSET>
<ROW>
<Dimension L="Time Dimension Values">1996</D>
< Dimension L="Product Dimension Values">TOTALPROD</D>
< Dimension L="Geography Dimension Values">WORLD</D>
< Dimension L="Channel Dimension Values">TOTALCHANNEL</D>
<Measure L="Dollar Sales">1.18247112042864E8</M>
<Measure L="Quota">5475441.87541972</M>
</ROW>
<ROW>
< Dimension L="Time Dimension Values">1997</D>
< Dimension L="Product Dimension Values">TOTALPROD</D>
< Dimension L="Geography Dimension Values">WORLD</D>
< Dimension L="Channel Dimension Values">TOTALCHANNEL</D>
<Measure L="Dollar Sales">4.64121127850704E7</M>
<Measure L="Quota">2917189.84519184</M>
</ROW>
</ROWSET>
</PAGE>
</Query>
</BIData>

2.12 getWorkSheetList

This API call accepts SessionKey and WorkbookKey and provides the list of worksheets within a workbook that is specified in WorkbookKey.

API

Details

Method

Public WorksheetList getWorkSheetList(SessionKey aSessionKey, WorkbookKey  aWorkbookKey ) {}

Input:

- SessionKey

- WorkbookKey

Output

- WorksheetList

Exceptions

- java.rmi.RemoteException

The following table lists the fields of the structures.

Structure

Fields

WorksheetList

- Array of Worksheet objects

Worksheet

- WorksheetName

- WorksheetKey

- Array of Parameter objects.
This is always a zero-sized array.

WorksheetName

- String name

WorksheetKey

- String wsDevKey
Identifies a worksheet. For Discoverer Plus Relational and Discoverer Plus OLAP, this is a string.

- WorkbookKey

2.13 isSessionValid

This API call accepts a SessionKey and returns a Boolean value that indicates whether the specified session is valid.

API

Details

Method

Public boolean isSessionValid( SessionKey sKey ) { }

Input:

- SessionKey

Output

- true if session is valid, false otherwise

Exceptions

- java.rmi.RemoteException

2.14 login

This API call provides a mechanism for user identity propagation between the client application and the Discoverer Web Services. Authentication occurs during every invocation of the Discoverer Web Services. For more information, see "About authentication and authorization".For every login made by a client application, the Discoverer Web Services create a new Discoverer user session and allocate it to the user.This API call accepts UserCredential and LocaleBean information and returns a unique SessionKey, which is then passed to all other API calls. This API call does not create a new HTTP session if a session exists between the client application instance and the Discoverer Web Services.

API

Details

Method

Public SessionKey login(UserCredential aUserCredential, LocaleBean aLocale) { }

Input:

- UserCredential
This object must contain a valid login details of a Discoverer user.

- LocaleBean
This object passes locale information to the webservice session. By default the Locale is English (en-US).

Output

- SessionKey

Exceptions

- java.rmi.RemoteException

The following table lists the fields of the structures.

Structure

Fields

LocaleBean

- String language

- String country

- String variant

UserCredential

- Identifier anIdentifier

- DisplayName aDisplayName

Identifier

- String id

DisplayName

- String user

SessionKey

- String key
Securely generated random alphanumeric sequence.

2.15 logout

This API call informs the Discoverer Web Services API about the completion of the user session. This call frees the dedicated Discoverer session that was associated with the user session and returns the Discoverer session to the session pool.

API

Details

Method

Public void logout(SessionKey aSessionKey ) { }

Input:

- SessionKey

Output

- Void

Exceptions

- java.rmi.RemoteException

2.16 requestQueryCancel

This API call cancels a query request and removes the resources that are associated with that request. Call this method for queries that have been submitted but whose data has not yet been fetched. If the query data has been fetched, then the resources are removed. This asynchronous API call returns immediately.

API

Details

Method

Public Void requestQueryCancel(SessionKey aSessionKey, QueryKey){ }

Input:

- SessionKey

Output

- Void

Exceptions

- java.rmi.RemoteException

2.17 submitWorksheetQuery

This API call submits the query for the specified worksheet for execution. This asynchoronous API call returns immediately, without waiting for the query execution to complete.

API

Details

Method

Public QueryKey submitWorksheetQuery(SessionKey aSessionKey, WorksheetKey aWorksheetkey, List aParameteSelectList, QueryOption aQueryOption){ }

Input:

- SessionKey

- WorksheetKey

- Java.util.List of ParameterSelect

- QueryOption

Output

- QueryKey

Exceptions

- java.rmi.RemoteException

The following table lists the fields of the structures.

Structure

Fields

QueryKey

- String queryId
A secure and unique key that is randomly generated.

ParameterSelect

- ParameterKey

- Array of ParameterValue objects

QueryOption

- int NoOfRows
The number of rows to return in Rowset XML. The default is 25.

- int NoOfRows
The number of rows to return in Rowset XML. The default is 25.

- int chunksize
The size of data chunks in kilobytes for PDF, XLS and HTML formats. The default is 64 KB.

- ResultType

- UserCredential
The GUIDUsername or SSOUsername of the user for whom the query is run. If no user name is specified, then the query is run for the user who has logged in.

LocaleBean

- String type

Valid types are:

- XMLROWSET

- HTML - base64 encoded content returned in data string

- PDF - base64 encoded content returned in data string

- XLS - base64 encoded content returned in data string

Index
A  C  D  E  J  O  S  T  W

A

API calls

getConnectionList (), 2.2

getFolderEntryList (), 2.3

getLayoutMetaData (), 2.4

getParameterMetaData (), 2.5

getParameterValueList (), 2.6, 2.7

getQueryStatus (), 2.8

getVersion (), 2.9

getViewerURL (), 2.10

getWorksheetData (), 2.11

getWorkSheetList (), 2.12

isSessionValid (), 2.13

login (), 2.14

logout (), 2.15

requestQueryCancel (), 2.16

submitWorksheetQuery (), 2.17

authentication and authorization, 1.5, 1.6 availability requirements, 1.9

C

creating web service client stubs, 1.12.4

D

diagnosing problems, 1.11

Discoverer Web Services API

requirements for invoking, 1.12

verifying access to, 1.12.2

E

Endpoint URL, 1.3

error messages, 1.10

J

Java class example that might invoke the Discoverer Web Services, 1.15

O

Oracle BI Discoverer Web Services

about, 1.2

S

sessions

maintaining, 1.7

pool size, 1.8

SOAP endpoint URL, 1.3 SOAP protocol, 1.1

T

typical flow of events

detailed task examples, 1.14

list, 1.13

W

writing client application

using generated web service client stubs, 1.12.6

WSDL format, 1.4

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2014, Oracle and/or its affiliates. All rights reserved.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.