Siebel Analytics Web Administration Guide > Integrating Siebel Analytics Web Into Corporate Environments Using HTTP >

Referencing Dashboard Content in External Portals or Applications Using the Siebel Analytics Web Dashboard URL

This section describes how to use the Siebel Analytics Web Dashboard URL. It contains the following topics:

• About the Siebel Analytics Web Dashboard URL
• Structure of the Basic Siebel Analytics Web Dashboard URL
• Optional Parameters for the Siebel Analytics Web Dashboard URL

About the Siebel Analytics Web Dashboard URL

The Siebel Analytics Web Dashboard URL is for use in incorporating or referencing the content of a specific Siebel Intelligence Dashboard in external portals or applications. It has a number of forms and optional arguments that can be used to control its behavior.

You can post the Dashboard URL command as a Form or issue it as a URL. If you are issuing parameters as part of a URL, they need to be escaped properly. You need to replace spaces with plus ( + ) signs, and so on. For example, to pass East Region as a value, type East+Region.

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

saw.dll?Dashboard

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

/Analytics/saw.dll?Dashboard

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

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

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

Structure of the Basic Siebel Analytics Web Dashboard URL

The basic Dashboard URL command needs no parameters. It displays the user's default portal, after authenticating the user.

This is the format:

saw.dll?Dashboard

Optional Parameters for the Siebel Analytics Web Dashboard URL

You can modify the behavior of the dashboard URL command by adding one or more of the following parameters. If an invalid URL is specified (for example, you type a parameter incorrectly), the browser returns a "The page cannot be found" error with 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 is prompted for user ID and password information, unless the user chose the option to have logon information remembered when last logged on. If using a Session ID or Ticket, pass it as the NQUser parameter.

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 displays the dashboard.

PortalPath. This parameter allows you to direct the user to a specific dashboard. If the user does not have permission to the dashboard, an Access Denied error is returned.

This is the format, where ppp is the fully qualified path of the dashboard in the Web Catalog, and x+x is the name of the dashboard to display.

saw.dll?Dashboard&PortalPath=/Shared/Test/_Portal/x+x&NQUser=sessionid

Example:

saw.dll?Dashboard&PortalPath=/Shared/Test/_Portal/Sales+Dashboard&NQUser=sessionid

This authenticates the user using the provided session ID, and displays the Sales Dashboard.