Bookshelf Home | Contents | Index | PDF     

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

Summary of Web Services and Methods Supported by the Siebel Analytics Web SOAP API

This section provides a summary of the Web Services and the methods supported by each service.

  • SAWSessionService. Defines authentication services such as logon and logoff, and other session-related services. Supported methods include:
    • logon()

      Authenticates the user.

    • logoff()

      Logs the user off Siebel Analytics Web.

    • getCurUser()

      Gets the current user ID for the session.

    • keepAlive()

      Instructs Siebel Analytics Web not to end particular sessions due to inactivity.

    • impersonate()

      Logs on and then impersonates the user.

  • HtmlViewService. Allows the embedding of Siebel Analytics Web results in third-party dynamic Web pages and portal frameworks. Supported methods include:
    • startPage()

      Creates a new page object and returns its ID.

    • endPage()

      Destroys a server page object and all data associated with it.

    • addReportToPage()

      Adds results to an HTML page.

    • getHeadersHTML()

      Gets HTML to include in the <HEAD> section.

    • getCommonBodyHTML()

      Gets HTML to include in the <BODY> section.

    • getHTMLForReport()

      Gets HTML to display a particular set of results.

    • setBridge()

      Specifies a bridge URL to receive communications. Can be useful when the Siebel Analytics Web server and the user's Web server reside on different machines or when you want to modify the results in your application development environment.

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

  • XMLView Service. Retrieves results from Siebel Analytics Web in XML format. One method is supported:
    • getResults()

      Returns the report results, in XML format.

  • ReportEditingService. Merges parameters and Siebel Analytics Web data to create and return the results. Supported methods include:
    • applyReportParams()

      Applies report parameters to the report object and returns the results.

    • generateReportSQL()

      Retrieves the SQL query a given report.

  • WebCatalogService. Provides methods for navigating and managing the Web Catalog, and reading and writing Web Catalog objects in XML format. Supported methods include:
    • copyItem()

      Copies an object from one location to another in the Web Catalog.

    • createFolder()

      Creates a new folder in the Web Catalog.

    • createLink()

      Creates a link to the Web Catalog.

    • deleteItem()

      Deletes an object from the Web Catalog.

    • getItemInfo()

      Gets Web Catalog information for an object.

    • getSubItems()

      Gets the collection of child subitems for an object in the Web Catalog.

    • moveItem()

      Moves an object in the Web Catalog to a different location in the catalog.

    • writeSavedFilter()

      Writes a filter to the Web Catalog.

    • readObject()

      Reads an object from the Web Catalog.

    • removeFolder()

      Deletes a folder from the Web Catalog.

    • setItemProperty()

      Sets a property for an object in the Web Catalog.

    • writeObject()

      Writes an object to the Web Catalog.

    • writeReport()

      Writes a set of results to the Web Catalog.

    • writeDashboard()

      Writes a dashboard object to the Web Catalog.

    • writeDashboardPrompt()

      Writes a dashboard prompt to the Web Catalog.

    • writeDashboardPage()

      Writes a dashboard page to the Web Catalog.

    • writeSavedFilter()

      Writes a filter to the Web Catalog.

      NOTE:  Access rights to Web Catalog content are enforced when using the Siebel Analytics Web SOAP API. For example, if the user name used to establish the SOAP session does not have access to certain Siebel Answers content in the Web Catalog, the content is not accessible using the Siebel Analytics Web SOAP API.

    
Siebel Analytics Web Administration Guide