Bookshelf v7.7: Overview of the Siebel Analytics Web HtmlViewService Service

The HtmlViewService service allows the embedding of Siebel Analytics Web 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 Siebel Analytics Web content with the content of third-party Web pages.

HTML methods extract fragments of HTML code that can be inserted in third-party Web pages. The HTML code excerpts and desired page locations are described in Table 7.

Table 7. 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 report links. The code contains hidden HTML elements that are used to implement drilldown links.

For each returned report 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 report. While the report is being constructed by Siebel Analytics Web, the user sees the Siebel Analytics Web "Searching..." image (the default image is a spinning arrow) embedded on the third-party Web page.

For smooth report transitioning, Siebel Analytics Web tracks the Analytics reports that have been added to a third-party Web page 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.

About HtmlViewService Bridging and Callback URLs

To embed a report with active drilldown links, the HtmlViewService service allows the Web browser to issue callback requests from embedded reports to the Siebel Analytics Web server. Although it is possible to route requests directly to the Siebel Analytics Web server, in many cases it is preferable to route requests through the Web server that originally serviced the third-party page. Also, in situations where Siebel Analytics Web and the third-party Web server do not belong to the same Domain Name Service (DNS) domain, users may see JavaScript errors related to browser security constraints for cross-domain scripting.

To avoid these issues, you can 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 reroute requests to Siebel Analytics Web is not provided. This function would need to be fulfilled by the third-party application. For more information about the setBridge() method, see Specifying an Bridge URL Using the setBridge() Method in the Siebel Analytics Web SOAP API.