Bookshelf Home | Contents | Index | Search | PDF

Siebel Analytics Web Administration Guide > Siebel Analytics Integration API >

Using the Go URL

---

Siebel Analytics Web's Go URL is for use in incorporating specific Siebel Analytics results into external portals or applications. This is the URL used when you add a result to your favorites, or add a link to a request to your dashboard or an external Web site. It has a number of forms and optional arguments that can be used to control its behavior.

The Go command can be posted as a Form, or as issued as a URL. If you are issuing parameters as part of a URL, they need to be escaped properly. Spaces need to be replaced with plus ( + ) signs, and so on. For example, to pass East Region as a value, you type East+Region.

When called from within a Siebel Analytics Web page, such as a dashboard or an HTML result view, the URL should begin with this:

saw.dll?Go

When called from another page on the same Web server, the URL should begin with this:

/Analytics/saw.dll?Go

When referenced from a page on a different server (or sent through email, and so on), it should begin with the fully qualified server name or IP address:

http://server_name_or_ip_address/Analytics/saw.dll?Go

To test these commands, you can enter the fully qualified version into the Address field in Internet Explorer 5.

About the Basic Go URL

The basic Go URL needs the full Web Catalog path to the request you want to execute. It will return the default result view, as defined in the request.

For example, this returns the default result view as defined in the request, where SB2 is the name of the request to execute.

saw.dll?Go&Path=/Shared/Test/SB2

Optional Parameters

You can modify the behavior of Go by adding one or more of the following parameters. If an invalid URL is specified (for example, you type a parameter incorrectly), the browser will display a "The page cannot be found" error with the detailed text of "HTTP 400 - Bad Request."

NOTE:  In parameter descriptions, SB2 is the name of the request to execute.

User ID and Password. If omitted, the user will be prompted for user ID and password information, unless the user chose the option to have logon information remembered when last logged on.

This is the format, where uuu is the user ID and ppp is the password:

&NQUser=uuu&NQPassword=ppp

Example:

saw.dll?Go&Path=/Shared/Test/SB2&NQUser=user1&NQPassword=rock

This logs on as user1 with a password of rock, and executes the request.

Link Options. The results will include links.

This is the format:

&Options=x

The x can be one or more of the following letters:

Letter	Link
m	Modify Request
f	Printer Friendly
d	Download to Excel
r	Refresh Results

Example:

saw.dll?Go&Path=/Shared/Test/SB2&Options=md

This displays results with the links Modify Request and Download Data.

Printer Friendly. Results are in a printer-friendly format, without the tape deck paging control, hot links, and so on.

This is the format:

&Action=print

Example:

saw.dll?Go&Path=/Shared/Test/SB2&Action=Print

Application Friendly. Results are displayed in an application-friendly format, such as for Microsoft Excel, without the tape deck paging control, hot links, the Powered by Siebel Analytics phrase, and so on.

This is the format:

=&Action=Extract

Example:

saw.dll?Go&Path=/Shared/Test/SB2&Action=Extract

The Extract action also acts as a Navigate action (see Passing Filters to the Go Command Through a URL (Navigation)) so you can filter the results that are returned by the call.

Specific View. This shows an individual result view rather than the default compound view.

This is the format, where xx is the name of the view:

saw.dll?Go&Path=/Shared/Test/SB2&ViewName=xx

Example:

saw.dll?Go&Path=/Shared/Test/SB2&ViewName=Chart

Assuming that the request contains a Chart view named Chart, this displays just the Chart view.

Specific Style. This shows the results using a specified style. If the style does not exist, the default will be used.

This is the format, where xx is the name of the style:

saw.dll?Go&Path=/Shared/Test/SB2&Style=xx

Example:

saw.dll?Go&Path=/Shared/Test/SB2&Style=Lime

This uses the style named Lime to show the results.

Result Format. This controls the format of the results.

This is the format, where xx is XML or HTML:

saw.dll?Go&Path=/Shared/Test/SB2&Format=xx

Example:

saw.dll?Go&Path=/Shared/Test/SB2&Format=XML

This shows results in XML.

Displaying All Records in a Table

There are two ways to display all the records in the table:

Set the Rows per Page property on the Table view to 10,000, and then use the basic Go. This is the easier of the two methods.
Issue the following URL, assuming the View you want to control is called Table.

saw.dll?Go&Path=/Shared/Test/SB2&Action=Scroll&P5=-1&ViewID=go~Table

Bookshelf Home | Contents | Index | Search | PDF