Skip Headers
Oracle® Fusion Middleware Integrator's Guide for Oracle Business Intelligence Enterprise Edition
11
g
Release 1 (11.1.1)
Part Number E16364-04
Home
Book List
Index
Contact Us
Next
PDF
·
Mobi
·
ePub
Contents
List of Figures
List of Tables
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documentation and Other Resources
Conventions
New Features for Oracle Business Intelligence Developers
New Features for Oracle BI EE 11
g
Release 1 (11.1.1.6)
New Features for Oracle BI EE 11
g
Release 1 (11.1.1.5)
New Features for Oracle BI EE 11
g
Release 1 (11.1.1.3)
System Requirements and Certification
Part I Using Oracle BI EE Web Services
1
Introduction to Oracle Business Intelligence Web Services
1.1
Overview of the Oracle Business Intelligence Web Services
1.2
What are the Oracle Business Intelligence Session-Based Web Services?
1.3
What are the Oracle Business Intelligence Web Services for SOA?
1.4
Configuring and Securing the Oracle Business Intelligence Web Services for SOA
1.5
Enabling SSL for Web Services Communication
1.6
Invoking Oracle Business Intelligence Web Services Over HTTPS
2
Description of Structures in Oracle BI EE Web Services
2.1
AccessControlToken Structure
2.2
Account Structure
2.3
ACL Structure
2.4
ArrayofGUIDS Structure
2.5
AuthResult Structure
2.6
CatalogItemsFilter Structure
2.7
CatalogObject Structure
2.8
ErrorInfo Structure
2.9
GetSubItemsParams Structure
2.10
ImportError Structure
2.11
ItemInfo Structure
2.12
NameValuePair Structure
2.13
PathMap Structure
2.14
Privilege Structure
2.15
QueryResults Structure
2.16
ReportHTMLOptions Structure
2.16.1
ReportHTMLLinksMode Enumeration
2.17
ReportParams Structure
2.18
ReportRef Structure
2.19
SAColumn Structure
2.19.1
SADataType Values
2.19.2
AggregationRule Values
2.20
SASubjectArea Structure
2.21
SATable Structure
2.22
SAWLocale Structure
2.23
SAWSessionParameters Structure
2.24
SegmentationOptions Structure
2.25
SessionEnvironment Structure
2.26
StartPageParams Structure
2.27
TreeNodePath Structure
2.28
UpdateACLParams Structure
2.28.1
UpdateACLMode Enumeration
2.29
UpdateCatalogItemACLParams Structure
2.30
Variable Structure
2.31
XMLQueryExecutionOptions Structure
3
Description of Services and Methods in Oracle BI EE Web Services
3.1
ConditionService Service
3.1.1
evaluateCondition() Method
3.1.1.1
Signature
3.1.2
evaluateInlineCondition() Method
3.1.2.1
Signature
3.1.3
getConditionCustomizableReportElements() Method
3.1.3.1
Signature
3.2
HtmlViewService Service
3.2.1
About HtmlViewService Bridging and Callback URLs
3.2.2
addReportToPage() Method
3.2.2.1
Signature
3.2.3
endPage() Method
3.2.3.1
Signature
3.2.4
getCommonBodyHTML() Method
3.2.4.1
Signature
3.2.4.2
Returns
3.2.5
getHeadersHTML() Method
3.2.5.1
Signature
3.2.5.2
Returns
3.2.6
getHtmlforPageWithOneReport() Method
3.2.6.1
Signature
3.2.7
getHTMLForReport() Method
3.2.7.1
Signature
3.2.7.2
Returns
3.2.8
setBridge() Method
3.2.8.1
Signature
3.2.8.2
Usage
3.2.8.3
How Callback URLs Are Replaced
3.2.9
startPage() Method
3.2.9.1
Signature
3.2.9.2
Returns
3.3
iBotService Service
3.3.1
writeIBot() Method
3.3.1.1
Signature
3.3.2
deleteIBot() Method
3.3.2.1
Signature
3.3.3
executeIBotNow() Method
3.3.3.1
Signature
3.3.4
moveIBot() Method
3.3.4.1
Signature
3.3.5
sendMessage() Method
3.3.5.1
Signature
3.3.6
subscribe() Method
3.3.6.1
Signature
3.3.7
unsubscribe() Method
3.3.7.1
Signature
3.4
JobManagementService Service
3.4.1
cancelJob() Method
3.4.1.1
Signature
3.4.2
deleteResultSet() Method
3.4.2.1
Signature
3.4.3
getCounts() Method
3.4.3.1
Signature
3.4.4
getJobInfo() Method
3.4.4.1
Signature
3.4.5
getPromptedColumns() Method
3.4.5.1
Signature
3.4.6
prepareCache() Method
3.4.6.1
Signature
3.4.7
purgeCache() Method
3.4.7.1
Signature
3.4.8
saveResultSet() Method
3.4.8.1
Signature
3.4.9
writeListFiles() Method
3.4.9.1
Signature
3.5
MetadataService Service
3.5.1
clearQueryCache() Method
3.5.1.1
Signature
3.5.2
describeColumn() Method
3.5.2.1
Signature
3.5.2.2
Returns
3.5.3
describeSubjectArea() Method
3.5.3.1
Signature
3.5.3.2
SASubjectAreaDetails Values
3.5.3.3
Returns
3.5.3.4
Usage
3.5.4
describeTable() Method
3.5.4.1
Signature
3.5.4.2
SATablesDetails Values
3.5.4.3
Returns
3.5.5
getSubjectAreas() Method
3.5.5.1
Signature
3.5.5.2
Returns
3.5.5.3
Usage
3.6
ReplicationService Service
3.6.1
ExportFlags Enumeration
3.6.2
ImportFlags Enumeration
3.6.3
Import() Method
3.6.3.1
Signature
3.6.3.2
Returns
3.6.4
export() Method
3.6.4.1
Signature
3.6.5
markForReplication() Method
3.6.5.1
Signature
3.6.6
purgeLog() Method
3.6.6.1
Signature
3.7
ReportEditingService Service
3.7.1
applyReportDefaults() Method
3.7.1.1
Signature
3.7.1.2
Returns
3.7.2
applyReportParams() Method
3.7.2.1
Signature
3.7.2.2
Returns
3.7.3
generateReportSQL() Method
3.7.3.1
Signature
3.7.3.2
Returns
3.8
SAWSessionService Service
3.8.1
getCurUser() Method
3.8.1.1
Signature
3.8.1.2
Returns
3.8.2
GetSessionEnvironment() Method
3.8.2.1
Signature
3.8.2.2
Returns
3.8.3
getSessionVariable() Method
3.8.3.1
Signature
3.8.3.2
Returns
3.8.4
impersonate() Method
3.8.4.1
Signature
3.8.4.2
Returns
3.8.5
impersonateex() Method
3.8.5.1
Signature
3.8.5.2
Returns
3.8.6
keepAlive() Method
3.8.6.1
Signature
3.8.7
logoff() Method
3.8.7.1
Signature
3.8.8
logon() Method
3.8.8.1
Signature
3.8.8.2
Returns
3.8.9
logonex() Method
3.8.9.1
Signature
3.8.9.2
Returns
3.9
SecurityService Service
3.9.1
forgetAccounts() Method
3.9.1.1
Signature
3.9.2
getAccounts() Method
3.9.2.1
Signature
3.9.3
getGlobalPrivilegeACL() Method
3.9.3.1
Signature
3.9.4
getGlobalPrivileges() Method
3.9.4.1
Signature
3.9.5
getGroups() Method
3.9.5.1
Signature
3.9.6
getMembers() Method
3.9.6.1
Signature
3.9.7
getPermissions() Method
3.9.7.1
Signature
3.9.7.2
Returns
3.9.8
getPrivilegesStatus() Method
3.9.8.1
Signature
3.9.9
isMember() Method
3.9.9.1
Signature
3.9.10
joinGroups() Method
3.9.10.1
Signature
3.9.11
leaveGroups() Method
3.9.11.1
Signature
3.9.12
renameAccounts() Method
3.9.12.1
Signature
3.9.12.2
Returns
3.9.13
updateGlobalPrivilegeACL() Method
3.9.13.1
Signature
3.10
WebCatalogService Service
3.10.1
ErrorDetailsLevel Enumeration
3.10.2
ReadObjectsReturnOptions Enumeration
3.10.3
copyItem() Method
3.10.3.1
Signature
3.10.4
copyItem2() Method
3.10.4.1
Signature
3.10.5
createFolder() Method
3.10.5.1
Signature
3.10.6
createLink() Method
3.10.6.1
Signature
3.10.7
deleteItem() Method
3.10.7.1
Signature
3.10.8
getItemInfo() Method
3.10.8.1
Signature
3.10.8.2
Returns
3.10.9
getSubItems() Method
3.10.9.1
Signature
3.10.9.2
Returns
3.10.10
maintenanceMode() Method
3.10.10.1
Signature
3.10.11
moveItem() Method
3.10.11.1
Signature
3.10.12
pasteItem2() Method
3.10.12.1
Signature
3.10.13
readObjects() Method
3.10.13.1
Signature
3.10.13.2
Returns
3.10.14
removeFolder() Method
3.10.14.1
Signature
3.10.15
setItemAttributes() Method
3.10.15.1
Signature
3.10.16
setItemProperty() Method
3.10.16.1
Signature
3.10.17
setOwnership() Method
3.10.17.1
Signature
3.10.18
updateCatalogItemACL() Method
3.10.18.1
Signature
3.10.19
writeObjects() Method
3.10.19.1
Signature
3.10.19.2
Returns
3.11
XMLViewService Service
3.11.1
XMLQueryOutputFormat Enumeration
3.11.2
cancelQuery() Method
3.11.2.1
Signature
3.11.3
executeSQLQuery() Method
3.11.3.1
Signature
3.11.3.2
Returns
3.11.4
executeXMLQuery() Method
3.11.4.1
Signature
3.11.4.2
Returns
3.11.5
fetchNext() Method
3.11.5.1
Signature
3.11.5.2
Returns
3.11.6
getPromptedFilters() Method
3.11.6.1
Signature
3.11.7
upgradeXML() Method
3.11.7.1
Signature
Part II Oracle Business Intelligence Metadata Web Service
4
Using the Oracle Business Intelligence Metadata Web Service
4.1
Overview of the Oracle BI Metadata Web Service
4.2
Configuring the Web Service Connection to Oracle BI Server
4.2.1
How to Set Up a BI JDBC Data Source
4.3
Calling and Securing the Oracle BI Metadata Web Service
4.3.1
How to Call the Web Service
4.3.1.1
callProcedure() Method
4.3.1.2
callProcedureWithResults() Method
4.3.2
Securing the Web Service
4.3.2.1
Applying Policies
4.3.2.2
Configuring WSM
4.3.2.3
Configuring SAML
4.3.2.4
Assigning the manageRepositories Permission
4.3.2.5
Sample Code
4.4
Using the Oracle BI Server XML Procedures
4.4.1
Extract Project Procedure
4.4.2
Modify Metadata Procedure
4.4.3
Query Metadata Procedure
4.4.4
Query Projects Procedure
Part III Configuring the Action Framework
5
Using Actions to Integrate Oracle BI EE with External Systems
5.1
What is the Action Framework?
5.1.1
What Functionality is Provided by the Action Framework?
5.1.2
Action Types and Action Execution
5.2
Overview of the Action Framework Configuration
5.2.1
Configuration Checklist by Action Type
5.2.2
Overview of Targets
5.3
Configuring the Action Framework
5.3.1
Aliases
5.3.2
Registries
5.3.2.1
Navigate to EPM Content Action Type Registry Example
5.3.2.2
Invoke a Java Method Action Type Registry Example
5.3.2.3
Invoke a Web Service Action Type Registry Example
5.3.2.4
Registry Elements Descriptions
5.3.2.5
Valid Values for the Provider-Class Element
5.3.3
Content Types
5.3.4
Accounts
5.3.4.1
Account Elements Descriptions
5.3.5
Policies
5.3.5.1
Policy Elements Descriptions
5.3.5.2
Policy Files
5.3.6
Proxy
5.3.6.1
Proxy Elements Descriptions
5.3.7
ebusinesssuiteconfig
5.3.8
siebelcrmconfig
5.4
Overview of Action Security
5.4.1
Oracle BI EE Credentials
5.4.2
Oracle BI EE Privileges
5.4.3
Oracle BI Presentation Catalog Permissions
5.5
Adding and Maintaining Credentials for Use With the Action Framework
5.5.1
Adding a Credential Map and Credential Key to the Credential Store
5.5.1.1
Example of Creating the Credential Map and Credential Key
5.5.2
Creating a Default Keystore
5.5.3
Configuring Oracle Web Services Manager
5.6
Target Functionality for Actions
5.6.1
Navigate to EPM Content
5.6.1.1
Prerequisites for This Action Type
5.6.1.2
What Happens When This Action Type is Invoked?
5.6.2
Navigate to E-Business Suite
5.6.2.1
Overview of Passing Context to Oracle E-Business Suite Java Forms
5.6.3
Navigate to Siebel CRM
5.6.4
Invoke a Web Service
5.6.4.1
Prerequisites for This Action Type
5.6.4.2
Example of a WSIL Document
5.6.4.3
Troubleshooting Actions to Invoke a Web Service
5.6.4.4
What Happens When This Action Type is Invoked?
5.6.5
Supported Functionality for Calling Web Services
5.6.5.1
Transport
5.6.5.2
Messaging
5.6.5.3
SOAP
5.6.5.4
Response Document
5.6.5.5
Service Description
5.6.5.6
Discovery Services
5.6.5.7
Security
5.6.5.8
Reliable Messaging and Transactions
5.6.6
Invoke a Java Method (EJB)
5.6.6.1
Prerequisites for This Action Type
5.6.6.2
Parameters for the EJB
5.6.6.3
What Happens When This Action Type is Invoked?
5.6.7
Invoke a Browser Script
5.6.7.1
JavaScript Functions
5.6.7.2
UserScript.js
5.6.7.3
What Happens When This Action Type is Invoked?
5.6.8
Invoke a Server Script
5.6.8.1
Prerequisites for This Action Type
5.6.8.2
What Happens When This Action Type is Invoked?
5.6.9
Invoke Agent
5.6.9.1
How Filters Work in Invoke Agent Actions
5.6.9.2
What Happens When This Action Type is Invoked?
5.6.10
Java Job
5.6.10.1
What Happens When This Action Type is Invoked?
Part IV Integrating Oracle BI EE With Other Systems
6
Integrating Oracle BI Presentation Services into Corporate Environments Using HTTP and JavaScript
6.1
Incorporating Oracle Business Intelligence Results into External Portals or Applications
6.1.1
About the Oracle BI Presentation Services Go URL
6.1.2
Structure of the Basic Oracle BI Presentation Services Go URL
6.1.3
Optional Parameters for the Oracle BI Presentation Services Go URL
6.1.3.1
Displaying All Records in a Table
6.2
Referencing Dashboard Content in External Portals or Applications
6.2.1
About the Oracle BI Presentation Services Dashboard URL
6.2.2
Structure of the Basic Oracle BI Presentation Services Dashboard URL
6.2.3
Optional Commands and Parameters for the Oracle BI Presentation Services Dashboard URL
6.3
Using the Oracle BI Presentation Services Go URL to Issue SQL and Pass Filters
6.3.1
Issuing SQL Commands and Passing Filters
6.3.2
Passing Filters to the Oracle BI Presentation Services Go URL Through a URL (Navigation)
6.3.2.1
Navigation Parameters
6.3.2.2
Navigation Examples
6.3.2.3
Navigation Using JavaScript
6.3.2.4
Navigation from HTML Results
6.4
Example of an Oracle Business Intelligence Third-Party SQL Tool Integration
6.4.1
Example of integrating a third-party SQL tool
6.5
Retrieving Links to Dashboard Pages Using Scripts
7
Oracle Business Intelligence Systems Management API
7.1
What is the Oracle Business Intelligence Systems Management API?
8
Integrating Other Clients with Oracle Business Intelligence
8.1
Overview of Integrating with Oracle Business Intelligence
8.2
About Integrating with the Oracle BI Server as a Data Source
8.2.1
About Routing Requests to the Physical Layer
8.2.2
About Integrating with the Oracle BI Server Using JDBC
8.3
ODBC Conformance Level
8.4
Configuring an ODBC DSN for the Oracle BI Server on Windows
8.4.1
Configuring the ODBC DSN for Advanced SSL Settings
8.5
Configuring an ODBC DSN for the Oracle BI Server on Linux or UNIX
9
Using Discoverer Data in Applications
9.1
Exposing Discoverer Worksheets in Applications
9.2
Converting Discoverer Metadata to Use in Oracle BI EE
10
Integrating with Oracle E-Business Suite Security
10.1
Creating a Database Object and Connection Pool for the Oracle E-Business Suite Database
10.2
Setting Up Authentication
10.2.1
Setting Up Session Variables for Authentication
10.2.2
Updating authenticationschemas.xml
10.2.3
Updating instanceconfig.xml
10.3
Embedding Links to Oracle Business Intelligence in Oracle E-Business Suite
10.3.1
Domain Prerequisites
10.3.2
Creating a Form Function
10.3.3
Creating a Menu That Invokes the Form Function
10.3.4
Assigning the Menu to a Responsibility
10.3.5
Assigning the Responsibility to a User
10.3.6
Setting Up a Profile
11
Embedding Oracle BI EE In Oracle's Siebel CRM
11.1
Overview of Embedding Oracle BI EE in Oracle's Siebel CRM
11.2
Configuring Oracle HTTP Server
11.3
Configuring the Siebel Application to Find Oracle BI Through HTTP Server
11.4
Modifying the Siebel URLs to Reference the /analytics Directory
Glossary
Index
Scripting on this page enhances content navigation, but does not change the content in any way.