Siebel Analytics Web Administration Guide > Working with Data and Managing the Web Catalog Using Siebel Analytics Web SOAP API > Description of Methods in the Siebel Analytics Web SOAP API >

Adding Results to an HTML Page Using the addReportToPage() Method in the Siebel Analytics Web SOAP API


The addReportToPage() method in the HtmlViewService service adds results to an HTML page.

For information about the HtmlViewService service, see Overview of the Siebel Analytics Web HtmlViewService Service.

Description of Parameters in the addReportToPage() Method

The addReportToPage() method parameters are described in the following table.

Parameter
Description

String pageID

A character string page ID returned by the startPage() method.

For information about the startPage () method, see Creating a New Page Object Using the startPage() Method in the Siebel Analytics Web SOAP API.

String reportID

A character string that identifies the report containing the results to add to the page. It should be used to reference this report in subsequent SOAP calls; for example, corresponding user interface elements generated by the Siebel Analytics Web server would reference the same ID.

ReportRef report

The report definition, supplied in the ReportRef common structure.

For more information, see Referencing a Report Using the ReportRef Structure in the Siebel Analytics Web SOAP API.

ReportParams reportParams

The filters or variables to apply to the report before execution, supplied in the ReportParams common structure.

For more information, see Replacing Filters and Variables in a Report Using the ReportParams Structure in the Siebel Analytics Web SOAP API.

This parameter is optional.

ReportHTMLOptions options

The display options to apply to the report after execution, supplied in the ReportHTMLOptions structure.

For more information, see Defining HTML Display Options for Results Using the ReportHTMLOptions Structure in the Siebel Analytics Web SOAP API.

This parameter is optional.

String sessionID

A character string that identifies the session ID.

The session ID is usually returned by the logon call. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Siebel Analytics Web Administration Guide