Contents

Title and Copyright Information

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