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 >

Specifying an Bridge URL Using the setBridge() Method in the Siebel Analytics Web SOAP API


The setBridge() method in the HtmlViewService service specifies a bridge URL to receive communications. Specifying a bridge URL 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.

After the setBridge() method is called, all requests from the client browser to the Siebel Analytics Web server are sent to the bridge URL, which then forwards requests to the Siebel Analytics Web server.

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

Description of Parameters in the setBridge () Method

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

Parameter
Description

String bridgeURL

The bridge URL.

String sessionID

A character string that contains 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.

Usage Notes for the setBridge () Method

It is your responsibility to make sure that the client browser provides a handler to the bridge URL in the form of a Java servlet, an Active Server Pages (ASP) page, a Common Gateway Interface (CGI), an Internet Server application programming interface (ISAPI), or an equivalent application.

You must also perform the following tasks:

  • Decode the path of the requested Siebel Analytics Web resource in the RedirectURL parameter of the request character string. For information about the RedirectURL parameter, see How Callback URLs Are Replaced Using the Setbridge () Method.
  • Forward all other request parameters, together with all headers and the request body, to the bridge URL.
  • Copy the response from the Siebel Analytics Web server to the response stream.

How Callback URLs Are Replaced Using the Setbridge () Method

The new callback URL is based on the bridge URL, with the addition of a RedirectURL parameter. The value of the RedirectURL parameter should be the original value of the URL, encoded using standard URL encoding rules.

Internally, Siebel Analytics Web usually uses relative URLs for callback links. For example, if the original callback link is saw.dll?Go and the bridge URL is http://myserver/myapplication/sawbridge, the new callback URL is http://myserver/myapplication/sawbridge?RedirectURL=saw.dll%3fGo.

Siebel Analytics Web Administration Guide