PK
j?oa, mimetypeapplication/epub+zipPK j? iTunesMetadata.plistw
This part provides overview information for the Oracle BI EE Web Services, and information about the Session-Based Web service's structures and methods. This part contains the following chapters:
Shows the Find System Profile Values dialog.
PK8ǡ PK j? OEBPS/img_text/xml_ex_3.htmShows the updated repository in the Administration Tool, with details for the new Billed Qty object shown in the Presentation Column dialog.
PK$ PK j? OEBPS/img_text/xml_ex_2.htmShows the Presentation Column dialog in the Administration Tool for the Billed Qty object.
PKBO PK j? OEBPS/img_text/af_java_job.htmThis graphic illustrates the process that the system performs when a Java Job is triggered. The graphic illustrates the following steps:
The Oracle BI EE Scheduler requests the agent metadata from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the agent metadata to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler then requests the condition data from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the condition data to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler then requests the delivery content from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the delivery content to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler then requests the action definition and mapped parameters from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the action definition and mapped parameters to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler sends the action, including the mapped parameters, to the Javahost.
The Javahost executes the Java method.
The Javahost returns a message of success or failure to the Oracle BI EE Scheduler. The Oracle BI EE Scheduler receives and logs this message.
This graphic illustrates the process that the system performs when a Navigate to EPM action type is triggered. The graphic illustrates the following steps:
The Oracle BI EE user initiates the action.
Step one triggers Oracle BI EE Presentation Services to retrieve the action definition and mapped parameters.
Oracle BI EE Presentation Services then passes the action definition and mapped parameters back to the Oracle BI EE user. If necessary, the user provides additional parameter values and invokes the action.
After the user invokes the action, the browser sends an http request to the target system. The target system hosts the business intelligence object, Web page, or EPM report.
The target system completes the action by returning the resulting html to the Oracle BI EE user.
This graphic illustrates the process that the system performs when an Invoke a Browser Script action type is triggered. The graphic illustrates the following steps:
The Oracle BI EE user initiates the action.
Step one triggers Oracle BI EE Presentation Services to retrieve the action definition and mapped parameters.
Oracle BI EE Presentation Services then passes the action definition and mapped parameters back to the Oracle BI EE user. If necessary, the user provides additional parameter values and invokes the action.
The browser runs the JavaScript function referenced by the action definition and returns the results to the user.
This graphic illustrates the process that the system performs when an Invoke Agent is triggered. The graphic illustrates the following steps:
The Oracle BI EE Scheduler requests the agent metadata from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the agent metadata to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler then requests the condition data from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the condition data to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler then requests the delivery content from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the delivery content to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler then requests the action definition and mapped parameters from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the action definition and mapped parameters to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler sends the action, including the mapped parameters, to the Action Execution Service (AES).
AES invokes the external target for the action. An external target can be a Web service, EJB, or http. This process is synchronous.
The system initiates the target and sends a response to AES. This process is synchronous.
AES parses the response and returns a message of success or failure to the Oracle BI EE Scheduler. The Oracle BI EE Scheduler receives and logs this message.
Shows the Description tab of the Form Functions dialog.
PKU" PK j? OEBPS/img_text/xml_ex_1.htmFShows the Administration Tool main window with a logical column called 2-01 Billed Qty (Sum All). The image highlights the fact that there is no corresponding presentation column.
PKK F PK j? " OEBPS/img_text/ebiz_init_block.htm)Shows the Session Variable Initialization Block Data Source dialog, with values provided for Default initialization string and Connection Pool.
PKkG. ) PK j? ' OEBPS/img_text/ebiz_variable_target.htmcShows the Session Variable Initialization Block Variable Target dialog, with the following variables displayed:
EBS_RESP_ID
EBS_RESP_APPL_ID
EBS_SEC_GROUP_ID
EBS_RESP_NAME
EBS_USER_ID
EBS_EMPLOYEE_ID
USER
PKWN PK j? OEBPS/img_text/ebiz_ebs2.htmTShows the Menus dialog.
PK&.E PK j? OEBPS/img_text/ebiz_ebs4.htmTShows the Users dialog.
PKT% PK j? OEBPS/img_text/xml_test_prod.htmShows the Compare repositories dialog, with the two modified connection pool objects shown.
PK۷ PK j? OEBPS/img_text/ebiz_ebs3.htmIShows the Responsibilities dialog.
PKݷ; PK j? $ OEBPS/img_text/af_webservice_ejb.htm3This graphic illustrates the process that the system's performs when a Invoke Java Method (EJB) action type is triggered. The graphic shows the following steps in this process:
The Oracle BI EE user initiates the action from the browser.
Step one triggers Oracle BI EE Presentation Services to retrieve the action definition and mapped parameters.
Oracle BI EE Presentation Services then passes the action definition and mapped parameters back to the Oracle BI EE user. If necessary, the user provides additional parameter values and invokes the action.
After the user invokes the action, the browser sends an http request to the target system. The target system hosts the business intelligence object, Web page, or EPM report.
The target system completes the action by returning the resulting html to the Oracle BI EE user.
This graphic illustrates the process that the system performs when an Invoke a Server Script is triggered. The graphic illustrates the following steps:
The Oracle BI EE Scheduler requests the agent metadata from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the agent metadata to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler then requests the condition data from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the condition data to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler then requests the delivery content from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the delivery content to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler then requests the action definition and mapped parameters from Oracle BI EE Presentation Services. Oracle BI EE Presentation Services returns the action definition and mapped parameters to the Oracle BI EE Scheduler.
The Oracle BI EE Scheduler sends the action, including the mapped parameters, to the NQScriptEngine.
The NQScriptEngine executes the target Java and Visual Basic script.
NQScriptEngine returns a message of success or failure to the Oracle BI EE Scheduler. The Oracle BI EE Scheduler receives and logs this message.
This chapter describes the Oracle BI Metadata Web Service. This section contains the following topics:
Section 4.1, "Overview of the Oracle BI Metadata Web Service"
Section 4.2, "Configuring the Web Service Connection to Oracle BI Server"
Section 4.3, "Calling and Securing the Oracle BI Metadata Web Service"
The Oracle BI Server utilizes a semantic model to store and control behavior related to its operations. The semantic layer, called the Common Enterprise Information Model, is captured inside of metadata that is managed by the Oracle BI Administration Tool.
In previous versions of Oracle BI, you would use the Administration Tool to access the information stored in the metadata repository. However, in this version of Oracle BI, the Oracle BI Metadata Web Service allows you to use a Web service interface to call Oracle BI Server stored procedures. These procedures provide the ability to obtain information about the metadata and to modify the metadata.
For example, suppose that a Developer wants to build an analysis from an Essbase cube but does not have access to the Administration Tool and does not know how to create a metadata repository. The Developer can use a stored procedure to import the cube into Oracle BI Presentation Services and then query the cube to build the required analysis.
Use this topic if you are not using the default installation of Oracle BI Server. By default the Metadata Web Service attempts to connect to an instance of Oracle BI Server running at the following URL:
jdbc:oraclebi://localhost:9703/
However, if the Oracle BI server is deployed on a different machine, uses a different port, or if you want to configure an SSL connection between the Web service and the server, you should use a BI JDBC data source that you created in Oracle WebLogic Server Administration Console. The Web service will look for a data source with the following name, and if found, will use it to connect to the Oracle BI Server.
jdbc/bi/server
For instructions about how to create a BI JDBC data source, see "How to Create a BI JBDC Data Source in WebLogic" in Oracle Fusion Middleware Developer's Guide for Oracle Business Intelligence Enterprise Edition.
However, note the following requirements for setting up a BI JDBC data source for use with the Metadata Web Service. After you have finished setting up this data source, be sure to stop and start the Web service so that your preferences are applied.
In the URL field located on the Connection Properties page of the New JDBC Data Source wizard, specify the port that you configured for Oracle BI Server. The existing instructions state that you should specify "9703," but it is likely that "9703" will not be the correct port number.
After you created and saved the BI JDBC data source, you must modify the data source's settings. Access the Settings for the data source and click the Connections Pool tab. Modify the settings as follows:
In the Statement Cache Size field, enter 0. Specifying this value disables the statement cache.
In the Advanced tab, go to the Connection Creation Retry Frequency field and enter 10 (or any number larger than 0).
This section contains information about calling, and securing the Web service.
The Web service is normally deployed at this location:
http://server:port/AdminService/AdminService
The WSDL can be found at this location:
http://server:port/AdminService/AdminService?WSDL
The Web service exposes two generic methods that you can use to call any stored procedure on the Oracle BI Server: callProcedure and callProcedureWithResults.
You can use this method to call procedures that are not expected to return a result set. Table 4-1 contains information about this method's arguments.
Table 4-1 callProcedure Method Arguments
Argument | Data Type | Description |
---|---|---|
procedureName |
String |
Name of the procedure to call. |
parameters |
List of parameters |
A sequence of parameter objects. Each parameter defines a type and value corresponding to the stored procedure arguments. Refer to the WSDL for the supported parameter types. |
Use this method to call procedures that are expected to return a result set.
This method returns an object that mimics the result set as a sequence of ResultsRow objects. Each ResultsRow contains one or more columns, and each column defines a type and value. If an error occurs, most stored procedures return at least one row with a single string column. Therefore, it is important to carefully check the returned results.
Table 4-2 contains information about this method's arguments.
Table 4-2 callProcedure Method Arguments
Argument | Data Type | Description |
---|---|---|
procedureName |
String |
Name of the procedure to call. |
parameters |
List of parameters |
A sequence of parameter objects. Each parameter defines a type and value corresponding to the stored procedure arguments. Refer to the WSDL for the supported parameter types. |
To properly secure the Web service, you must use Oracle Web Services Manager (WSM). To call the Web service, you must configure your client code with the correct client side policy and provide security credentials for a user with permission to call the stored procedures.
By default, the Web service is protected by the following predefined policy:
oracle/wss11_saml_token_with_message_protection_service_policy
To successfully call the Web service, you must apply the following predefined policy in your client code:
oracle/wss11_saml_token_with_message_protection_client_policy
For more information about WSM and how to apply and configure predefined policies, see Oracle Fusion Middleware Security and Administrator's Guide for Web Services.
You must configure WSM before you can successfully use the Web service. The configuration for the Oracle BI Metadata Web Service and the Action Framework are identical.
For information about configuring WSM to work with the Oracle BI Metadata Web Service, see "Configuring Oracle Web Services Manager".
The policies that you applied in the "Applying Policies" step require you to configure SAML. This configuration will ensure that the proper authentication is performed by inserting the SAML token into the request. When the Web service attempts to connect to the Oracle BI Server, it uses the system user credentials and then impersonates the user found in the request's SAML token.
For more information about configuring SAML, see Oracle Fusion Middleware Security and Administrator's Guide for Web Services.
You must provide the user who will run the Web service with the manageRepositories permission. For information about how to set up security and apply this permission, see Oracle Fusion Middleware Security Guide for Oracle Business Intelligence Enterprise Edition.
Use the following code to set up client-side security. You can use this code to set up a client-side instances of the Admin Service configured to pass authentication information in a SAML token. This code must reside in an authenticated Web application. The authentication information in the session will be passed automatically to the Web service. You will have to generate client-side proxy classes to use code such as the example code.
In this example, the proxies have been generated in the package adminwebservice.client.
import adminwebservice.client.*; /** * Looks up an instance of the Admin Service and sets the correct authentication information on it. * @return Admin Proxy to the admin service. */ protected Admin getAdminService() throws Exception { String SERVICE_NAMESPACE = "http://ws.admin.obiee.oracle/"; String SERVICE_NAME = "AdminService"; String PORT_NAME = "AdminPort"; String WSS_POLICY_CONFIG_FILE_SAML = "wss-policy-saml.xml"; URL wsdlURL = new URL ("http://localhost:7001/AdminService/AdminService?WSDL"); QName serviceQname = new QName(SERVICE_NAMESPACE, SERVICE_NAME); QName portQname = new QName(SERVICE_NAMESPACE, PORT_NAME); ServiceDelegateImpl serviceDelegate = new ServiceDelegateImpl (wsdlURL, serviceQname, OracleService.class); Admin admin = serviceDelegate.getPort( portQname, Admin.class); ((BindingProvider)admin).getRequestContext().put(ClientConstants.CLIENT_ CONFIG,toElement(this.getClass().getResourceAsStream(WSS_POLICY_CONFIG_ FILE_SAML))); ((BindingProvider)admin).getRequestContext().put(BindingProvider. ENDPOINT_ADDRESS_PROPERTY, getServiceUrl()); return admin; }
WSS_POLICY_CONFIG_FILE_SAML
WSS_POLICY_CONFIG_FILE_SAML is the resource name of a file with the following content:
<?xml version="1.0" encoding="UTF-8"?> <oracle-webservice-clients> <webservice-client> <port-info> <policy-references> <policy-reference uri="oracle/wss11_saml_token_with_ message_protection_client_ policy"category="security"/> </policy-references> </port-info> </webservice-client> </oracle-webservice-clients>
Oracle BI provides several BI Server XML procedures that you can use to call the Oracle BI Server via JDBC or ODBC.
This topic contains detailed information on the following procedures:
Use the Extract Project procedure to extract a project from the repository. The output results set contains a row for each project defined in the repository.
This procedure has the following structure:
NQSExtractMetadataProject Input 1. PROJECT_NAMES 2.RPD_NAME (optional) Output 1. RPD_OBJECT
Table 4-3 contains the Extract Project procedure's input and output parameters and their descriptions.
Table 4-3 Extract Projects Procedure Parameters and Descriptions
Parameter | Description |
---|---|
PROJECT_NAMES |
A delimited list of project names that will be sent to the procedure for extraction. |
RPD_NAME |
This parameter is currently not used. It is reserved for future use. |
RPD_OBJECT |
Contains a single BLOB object with the binary representation for the extracted repository. |
Use the Modify Metadata procedure to apply changes to the repository. The output result set will contain zero or one row. If the output returns one row, that row will contain error messages.
Note that you can modify metadata using other methods, such as command line utilities, for example, nqxudmlexec, nqxudmlcli, and by copying and pasting within the Administration Tool.
This procedure has the following structure:
NQSModifyMetadata Input 1. XUDML_TEXT 2. ORIGINAL_RPD (optional) 3. RPD_NAME (optional) Output 1. ERROR_MESSAGES
Table 4-4 contains the Modify Metadata procedure's input and output parameters and their descriptions.
Table 4-4 Modify Metadata Procedure Parameters and Descriptions
Parameter | Description |
---|---|
XUMDL_TEXT |
The full XUDML text that will be applied to the server. In general, the metadata definitions will be applied directly, overwriting existing definitions, unless the original repository is set in the input parameter. |
ORIGINAL_RPD |
The name of the repository to which Oracle BI compares the XUDML. Oracle BI compares the XUDML fragment to the original RPD that you specify, and if Oracle BI detects a conflict, it does not apply the XUDML. If no conflict is detected, Oracle BI applies the XUMDL. |
RPD_NAME |
This parameter is currently not used. It is reserved for future use. |
ERROR_MESSAGES |
Contains any returned errors resulting from the query execution. |
Use the Query Metadata procedure to query the repository for metadata. The output result set will contain as many rows as there are object matches. You must concatenate the results to obtain the fully formed XUDML document.
This procedure has the following structure:
NQSQueryMetadataObjects Input 1. OBJECT_TYPES 2. OBJECT_NAME (optional) 3. OBJECT_PARENT (optional) 4. CHILD_FLAG (optional) 5. RPD_NAME (optional) Output 1. XUDML_TEXT 2. ERROR_MESSAGES
Table 4-5 contains the Query Metadata procedure's input and output parameters and their descriptions.
Table 4-5 Query Metadata Procedure Parameters and Descriptions
Parameter | Description |
---|---|
OBJECT_TYPES |
A list of object types for which to search. You can query for multiple object types by adding a comma between object types. For example, you can query for subject area and presentation catalog objects by setting the object_types to a value of '2000,4004'. In this example, the subject area object has a type ID value of 2000 and presentation catalog object has a type ID value of 4004. |
OBJECT_NAME |
(Optional) Filter the objects matched by a name. This name is not the fully qualified name. For example, to query for all subject area named "AtomicStar", you would set the OBJECT_TYPES parameter to "2000" and the OBJECT_NAME parameter to "AtomicStar". |
OBJECT_PARENT |
(Optional) Filter the objects based on the name of the parent object. Use this parameter to specify a fully qualified name. |
CHILD_FLAG |
(Optional) If this parameter is set to "true," then the query returns all the child objects of the queried objects. For example, if you specify the object type parameter as Business Model and set the child flag parameter to "true," then all objects under the Business Model in the tree are returned. |
RPD_NAME |
This parameter is currently not used. It is reserved for future use. |
XUDML_TEXT |
Contains the returned XML representation of all the metadata. If the XML data is too large to fit in one row, it will be split and passed back in multiple rows. You must concatenate the results to obtain the fully formed XUDML document. |
ERROR_MESSAGES |
Contains any returned errors resulting from the query execution. |
Use the Query Projects procedure to determine what projects are in the repository. The output results set contains one row with a single BLOB as the output.
This procedure has the following structure:
NQSQueryMetadataProject Input 1. RPD_NAME (optional) Output 1. PROJECT_NAME
Table 4-6 contains the Query Projects procedure's input and output parameters and their descriptions.
This chapter describes the XML API elements for Oracle Marketing Segmentation objects, security objects, and miscellaneous objects that do not fall in other categories.
This chapter contains the following topics:
Marketing elements are typically those elements that are related to features for the Oracle Marketing Segmentation product. For information about features and options related to Oracle Marketing Segmentation, see the administrator documentation for the Oracle Marketing Segmentation application.
Marketing elements include:
The catalog link element corresponds to the conforming dimension link object in the Marketing metadata. A conforming dimension links a fact that contains target-level IDs to a fact that does not contain target-level IDs by navigating along a dimension that is shared by both fact tables.
The catalog link tag includes the following child elements:
Table 16-1 Catalog Link Child Elements
Element Name | Description |
---|---|
From |
References the presentation column that represents the primary key of the subject area from which the dimension link originates. The primary key column is contained in a sub-element called |
To |
References the presentation column that represents the primary key of the subject area to which the dimension link points. The primary key column is contained in a sub-element called |
The catalog link tag does not include any attributes.
Syntax
<CatalogLink …> <From> <RefPresentationColumn …/> </From> <To> <RefPresentationColumn …/> </To> </CatalogLink>
Example
<CatalogLink name="Customer Profile->Campaign Contacts" id="4012:280960" uid="2150823331"> <Description> PKAlH C PK j? OEBPS/methods.htm Description of Services and Methods in Oracle BI EE Web Services 3 Description of Services and Methods in Oracle BI EE Web Services
This chapter describes the services and methods in Oracle BI EE Web Services.
Note:
This document uses JavaScript-like syntax to describes structures. The exact syntax and implementation depends on the SOAP code generation tool and the target language used by your application development environment.This chapter describes the following services.
3.1 ConditionService Service
Use this service to evaluate Oracle BI EE conditions programatically. This service also allows users to obtain the customizable filters available in a condition.
Table 3-1 shows the supported methods.
Table 3-1 ConditionService Methods
Method Name Description Section 3.1.1, "evaluateCondition() Method"
Evaluates a condition saved to the catalog.
Section 3.1.2, "evaluateInlineCondition() Method"
Evaluate a condition supplied as a parameter.
Section 3.1.3, "getConditionCustomizableReportElements() Method"
Obtains the customizable filters of a condition saved to the catalog.
3.1.1 evaluateCondition() Method
Use this method to evaluate a Condition that is stored in the catalog. This method returns an XML string containing the result of the condition (true or false).
3.1.1.1 Signature
boolean evaluateCondition(String path, String[] reportCustomizationParameters, String sessionID);
Arguments Description String path Specifies the full path and name of the Condition in the catalog. For example, /users/jchan/Conditions/IsRegionUnderBudget. String [] reportCustomizationParameters Specifies the customization parameters XML, which is only used if the Condition has customizable filters. This XML is validated against the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.xsd. String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. 3.1.2 evaluateInlineCondition() Method
Use this method to evaluate a condition defined outside of Oracle BI EE Presentation Services. The Condition XML is supplied in the conditionXML parameter. This method returns an XML string with the result of the condition evaluation, true or false.
3.1.2.1 Signature
boolean evaluateInlineCondition(String conditionXML, String[] reportCustomizationParameters, String sessionID);
Arguments Description String conditionXML Specifies the Condition XML. This XML is validated against the condition schema available in orahome/bifoundation/web/schemas/condition.xsd. String[] ListreportCustomizationParameters Specifies the customization parameters XML, which is only used if the Condition has customizable filters. This XML is validated against the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.xsd. String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. 3.1.3 getConditionCustomizableReportElements() Method
Use this method to determine the customizable filters available in a condition that is stored in the catalog. This method returns an XML string containing the definition of the customizable filters available in the condition. The XML is in the format defined in the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.xsd.
3.1.3.1 Signature
String[] getConditionCustomizableReportElements(String path, String sessionID);
Arguments Description String path Specifies the full path and name of the condition in the catalog. For example, /users/jchan/Conditions/IsRegionUnderBudget. String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. 3.2 HtmlViewService Service
Use this service to embed Oracle BI EE HTML results in third-party dynamic Web pages, such as Active Server Pages (ASP) or JavaServer Pages (JSP), and portal frameworks. The embed process merges Oracle BI EE Web Services content with the content of third-party Web pages.
Table 3-2 shows the supported methods.
Table 3-2 HtmlViewService Methods
Method Name Description Section 3.2.2, "addReportToPage() Method"
Adds results to an HTML page.
Section 3.2.3, "endPage() Method"
Destroys a server page object and all data associated with it.
Section 3.2.4, "getCommonBodyHTML() Method"
Retrieves HTML to include in the <BODY> section.
Section 3.2.5, "getHeadersHTML() Method"
Retrieves HTML to include in the <HEAD> section.
Section 3.2.6, "getHtmlforPageWithOneReport() Method"
Retrieves HTML for a page that contains only one analysis.
Section 3.2.7, "getHTMLForReport() Method"
Retrieves HTML to display a particular set of results.
Section 3.2.8, "setBridge() Method"
Specifies a bridge URL to receive communications. Can be useful when the Oracle Business Intelligence Web Services server and the Presentation Services that the user is accessing reside on different machines or when you want to modify the results in your application development environment.
Section 3.2.9, "startPage() Method"
Creates a new page object and returns its ID.
The methods in the HTMLViewService service extract fragments of HTML code that can be inserted in third-party Web pages. Table 3-3 describes the HTML code excerpts and desired page locations.
Table 3-3 HTML Code Fragments and Page Locations for the HtmlViewService Service
HTML Code Fragment Desired Page Location Header
Should be inserted in the <HEAD> section of an HTML page. The code contains links to common JavaScript files and style sheets.
Report Objects
Can be inserted anywhere in the <BODY> section.
Common Body
Should be inserted in the <BODY> tag after all analysis links. The code contains hidden HTML elements that are used to implement drilldown links.
For each returned analysis object, the HTML code fragment contains a callback link that is followed automatically when the Web page is loaded by the browser. The code fragment does not contain the full user interface definition of the analysis. While the analysis is being constructed by Oracle BI EE Presentation Services, the interface displays the Oracle BI EE Web Services "Searching..." image embedded on the third-party Web page.
For smooth analysis transitioning, Oracle BI EE Presentation Services tracks the Oracle Business Intelligence analyses that have been added to third-party Web pages by maintaining information in an internal logical page object during the construction of the third-party Web page. The HtmlViewService service methods explicitly refer to the internal logical page by its ID.
3.2.1 About HtmlViewService Bridging and Callback URLs
To embed an analysis with active drilldown links, the HtmlViewService service allows the Web browser to issue callback requests from embedded analyses to the Oracle BI EE Presentation Services server. Although it is possible to route requests directly to the Oracle BI EE Presentation Services server, in many cases it is preferable to route requests through the Oracle BI EE instance that originally serviced the third-party page. Also, in situations where Oracle BI EE Presentation Services and the third-party Web server do not belong to the same Domain Name Service (DNS) domain, users may get JavaScript errors related to browser security constraints for cross-domain scripting.
To avoid these issues, use the setBridge() method to modify callback URLs to point to the third-party Web server. Be aware that a Web component executed by the third-party Web server to re-route requests to Oracle BI EE Presentation Services is not provided. This function would need to be fulfilled by the third-party application. For more information about the setBridge() method, see Section 3.2.8, "setBridge() Method".
3.2.2 addReportToPage() Method
Use this method to add results to an HTML page.
3.2.2.1 Signature
void addReportToPage(String pageID, String reportID, ReportRef report, String reportViewName, ReportParams reportParams, ReportHTMLOptions options, String sessionID);
Arguments Description String pageID Specifies a character string page ID returned by the startPage() method. For information about the startPage () method, see Section 3.2.9, "startPage() Method". String reportID Specifies a character string that identifies the analysis containing the results to add to the page. It should be used to reference this analysis in subsequent method invocations; for example, corresponding user interface elements generated by the Oracle Business Intelligence Presentation Services server would reference the same ID. ReportRef report Specifies the analysis definition, supplied in the ReportRef structure. String reportViewName Specifies the view to display. If this parameter is null, the analysis' default view is used. The view name should match the one used to identify the view in the analysis XML definition. ReportParams reportParams Optional. Specifies the filters or variables to apply to the analysis before execution, supplied in the ReportParams common structure. For more information, see Section 3, "Description of Services and Methods in Oracle BI EE Web Services".
ReportHTMLOptions options Optional. Specifies the display options to apply to the analysis after execution, supplied in the ReportHTMLOptions structure. For more information, see Section 2.15, "QueryResults Structure". String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. 3.2.3 endPage() Method
Use this method to destroy the Oracle BI EE Presentation Services server page object and all data associated with it.
3.2.3.1 Signature
void endpage(String pageID, String sessionID);
Arguments Description String pageID Specifies the ID of the page object, which is returned by the startPage() method (for more information, see Section 3.2.9, "startPage() Method"). String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. 3.2.4 getCommonBodyHTML() Method
Use this method to retrieve HTML to include in the <BODY> section.
3.2.4.1 Signature
String getCommonBodyHTML(String pageID, String sessionID);
Arguments Description String pageID Specifies the ID of the page object, which is returned by the startPage() method (for more information, see Section 3.2.9, "startPage() Method"). String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. 3.2.5 getHeadersHTML() Method
Use this method to retrieve HTML to include in the <HEAD> section.
3.2.5.1 Signature
String getHeadersHTML(String pageID, String sessionID);
Arguments Description String pageID Specifies the ID of the page object, which is returned by the startPage() method (for more information, see Section 3.2.9, "startPage() Method"). String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. 3.2.6 getHtmlforPageWithOneReport() Method
Use this method to retrieve the HTML for a page that contains only one analysis. A page that contains only one analysis does not have <BODY> and <HEAD> sections.
3.2.6.1 Signature
String getHtmlForPageWithOneReport(String reportID, ReportRef report, String reportViewName, ReportParams reportParams, ReportHTMLOptions reportOptions, StartPageParams pageParams, String sessionID);
Arguments Description String pageReportID Specifies the analysis ID returned by the getHtmlForPageWithOneReport() method. For information about the addReportToPage method, see Section 3.2.2, "addReportToPage() Method".