| Bookshelf Home | Contents | Index | Search | PDF | |
Siebel Analytics Web Administration Guide > Siebel Analytics Web Integration API >
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 Dashboard URL
The Dashboard URL 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 screen, such as a dashboard or an HTML result view, the URL should begin with this:
When called from another screen on the same Web server, the URL should begin with this:
When referenced from a screen 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?Dashboard
To test these commands, you can enter the fully qualified version into the Address field in Internet Explorer.
The Basic Dashboard URL
The basic Dashboard URL command needs no parameters. It displays the user's default portal, after authenticating the user.
Optional Dashboard URL Parameters
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:
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
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.
| Bookshelf Home | Contents | Index | Search | PDF | |
Siebel Analytics Web Administration Guide Published: 11 March 2004 |