416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
This is the support page for the legacy Dundas Dashboard application. For assistance with the current Dundas BI application please click here.
Dashboard v5.0

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

Using Viewer.aspx

Hide navigation
RSS
Modified on Thu, 12 Jun 2014 11:23 AM Categorized as Viewer
Click here to return to: Documentation | Using the Dashboard Viewer in Your Applications


Overview

Sometimes you need to show a dashboard without embedding it in a Silverlight or ASP.NET application. The Viewer.aspx page installed with your Dundas Dashboard server lets you do this by passing dashboard IDs in a URL.

To link to Viewer.aspx and display a dashboard:

  1. Find the target dashboard's unique ID. Read this article to see how.
  2. Link to http://DASHBOARD_SERVER/PATH/Viewer.aspx, where DASHBOARD_SERVER is the host name and port of your Dashboard server (dashsvr:7000 for example), and PATH is the web application. You can find this URL by choosing Dundas Dashboard from your Start menu and copying the URL from your browser's address bar.
  3. Pass the ID and the desired content type (“Dashboard” in this case) in the URL.

As an example, if your URL to the Dashboard application is http://dashsvr:7000/Default.aspx, you can load one of the sample dashboards by visiting this URL:

http://dashsvr:7000/Viewer.aspx?Dd_ContentId=7bcebd59-d425-4f29-9ea4-73033d50d515&Dd_ContentType=Dashboard

Tip: If you're not logged in, clicking a link to Viewer.aspx will display the Dundas Dashboard login screen first, and then display the dashboard specified by Dd_ContentId.

URL parameters

The Viewer.aspx page accepts the following URL parameter options:

OptionDescription
Dd_ContentIdThe ID of a Dundas Dashboard object.
Dd_ContentTypeOne of Bookmark, DashBlock, Dashboard, or Mashup. These are the types for object IDs supported by Viewer.aspx.
Dd_DefaultFolderIdSet the default Location in the navigation bar by specifying the ID of a project or folder in the Design Explorer.
Dd_ParametersAny dashboard parameters, URL encoded and then HTML encoded.
Dd_ViewerFeaturesOptions to control the appearance of the viewer control. See below for the option syntax.

OptionDescription
dwSessionIdA Dashboard session ID for credentials. You can log in to the Dashboard server and get a session ID by using the Server's session APIs, found in the Dundas.Dashboard.Integration.IntegrationHelper class.
dwUsername and dwPasswordA username and password in plain text.

Warning: Using this option is not recommended as it is not secure.

OptionDescription
ddBgSrcSpecify the background for the Dundas Dashboard startup and login screens. For example, you can set an image URL, or provide a specific color. Accepts the same values as the Branding.LoginPageBackgroundSource key from the Dundas Dashboard Configuration File.
ddBgImgStretchA value indicating how the image specified by the ddBgSrc setting should be stretched. Accepts the same values as the Branding.LoginPageBackgroundImageStretch key from the Dundas Dashboard Configuration File.
ddCultureSpecify the culture to use (⪚ ddCulture=en-US). This setting won't be applied immediately if an existing login session (which has its own culture) is being reused. In this case, the new culture setting will take effect when the user logs out and logs back in.
ddIsolatedStorageQuotaThe Silverlight Isolated Storage quota in megabytes.

Tip: These URL parameter options also can be passed via “InitParams” if you are integrating the Viewer into your own applications.

Dd_ViewerFeatures options

Set Dd_ViewerFeatures to a semicolon-separated list of features you want to control:

OptionDescription
IsErrorMessagesSuppressed=trueDisable error/exception messages in the viewer. (Does not apply to the HTML Viewer.)
IsLogoVisible=falseDisable the logo.
IsNavigationCollapsed=trueShow the navigation bar, but in its collapsed form.
IsNavigationVisible=falseDisable the navigation bar.
IsToolbarVisible=falseDisable the toolbar.
IsToolbarCollapsed=trueShow the toolbar, but in its collapsed form.

For example, to turn off both the logo and toolbar, use Dd_ViewerFeatures=IsLogoVisible=false;IsToolbarVisible=false in your URL.

Related topics


Click here to return to: Documentation | Using the Dashboard Viewer in Your Applications

About Dundas | Contact Us Follow us on Twitter! | Privacy Statement | Report Site Issues

Copyright © 2009-2014 Dundas Data Visualization, Inc.