416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
Dashboard v5.0

This site makes extensive use of JavaScript.

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

Branding Dundas Dashboard

Hide navigation
RSS
Modified on Tue, 04 Mar 2014 05:05 PM Categorized as Configuration
Click to return to: Documentation


Overview

For branding purposes, there are several places in the user interface of Dundas Dashboard where default text, links, or logos can be replaced by your own choices. For example, you may want to change the title of the web application from “Dundas Dashboard” to the name of your company or organization.

Product name is changed in the title of the web page.

Product name is changed in the title of the web page.


Branding settings

Branding is controlled via a section of keys in the Dundas Dashboard Configuration File. By default, all branding-related keys are commented out in this file.

Branding settings can be used to re-brand Dundas Dashboard and use your own company logos, etc. in the application. These settings are most useful for partners or people embedding the Dashboard Viewer in their own applications.

To configure branding settings:

  1. Uncomment the branding keys that you want to change in the configuration file.
  2. Set the values of the branding keys.
  3. Restart the Dundas Dashboard website for the changes to take effect.

Screenshots of typical application areas which can be customized are shown in the following sections. However, for detailed usage information for each of the available keys, see the configuration file article and go to the Branding Settings section.

Note: For branding keys that let you substitute your own images (such as logos) via image URLs, you must ensure that your image URLs are accessible from the Dundas Dashboard server. Test your image URLs for this before making any settings change. If your images are on the Dundas Dashboard server, you can try using localhost in your image URLs, for example.

About Button

Use the Branding.AboutButtonCustomUri key to specify an absolute URL to go to when the user clicks the About button in the toolbar.

If you want to hide the About button altogether, set the Branding.ShowAboutButton key value to False.

The About button.

The About button.


Help Button

Use the Branding.HelpButtonUriBase key to specify an absolute URL to use as the base for any Help buttons/links shown by Dundas Dashboard.

Home Screen Welcome Message

The message window in the Home Screen can be customized in two ways:

  • Use the Branding.HomeScreenWelcomeMessageTitle key to change the title of the message window.
  • Use the Branding.HomeScreenWelcomeMessageText key to set the content of the message window. You can use certain HTML tags as described in Formatting Rich Text.

The title and content of the Home Screen's message window.

The title and content of the Home Screen's message window.


Login Screen

Use the Branding.LoginPageBackgroundSource key to specify the background for the Dundas Dashboard startup and login screens. For example, you can set an image URL, or provide a specific color.

If you use an image URL, you can additionally specify how the image should be stretched using the Branding.LoginPageBackgroundImageStretch key.

Changing the background color of the login screen.

Changing the background color of the login screen.


Logos

You can replace the Dundas logo in the Login screen, the primary application screen, and the About dialog with your own image.

Logo images should adhere to the sizes (in pixels) as specified in the configuration file article.

Login

Use the Branding.LoginPageLogoImageUri key to change the Dundas logo in the Login Screen (by supplying an image URL). This key also applies to the HTML Viewer Login screen.

The Dundas Logo in the Login Screen.

The Dundas Logo in the Login Screen.


Primary

Use the Branding.PrimaryLogoImageUri key to change the Dundas logo in the main application screen (top-left corner). This key also applies to the logo in the HTML Explorer toolbar.

The primary Dundas Logo in the top-left corner.

The primary Dundas Logo in the top-left corner.


You can also adjust the horizontal alignment of the logo image by using the Branding.PrimaryLogoImageHorizontalAlignment key.

The Branding.HtmlHomeLogoWeblinkUri key lets you change the URL that is launched when the user clicks on the primary (i.e. application) logo in the HTML Explorer/Home.

About

Use the Branding.AboutLogoImageUri key to change the Dundas logo in the About dialog.

About dialog logo.

About dialog logo.


Product Name

Use the Branding.ProductName key to change the name of the product as it appears in the application. By default, this key is set to “Dundas Dashboard”.

As an example, this key controls the title of the web page/application that appears in the caption and page tab of your web browser.

The product name as displayed in the web browser's caption and page tab.

The product name as displayed in the web browser's caption and page tab.


This key also determines the name of the product that is displayed in the login screen.

The product name as displayed in the Login Screen.

The product name as displayed in the Login Screen.


URL Icon

You can also change the icon that appears in your browser's URL address bar and the page tab.

Simply modify or replace the url_icon.ico file which is located in the “www” folder of your Dundas Dashboard instance. By default, this folder is:

C:\Program Files\Dundas Data Visualization Inc\Dundas Dashboard\{InstanceName}\www

Make a backup of the existing icon file before modifying or replacing it. Also, note that browsers tend to cache this object very aggressively, so you may need to clear your browser cache in order to see the updated icon. Windows may also have cached your icon preview, so open the icon file to ensure that its content is correct.

Wait Indicator

You can also customize the wait indicator which appears, for example, when you log in to Dundas Dashboard or preview a KPI.

Use the Branding.WaitIndicatorImageUri key to change the small image that is shown in the center of the wait indicator:

Wait indicator.

Wait indicator.


The Branding.WaitIndicatorPrimaryColor key lets you set the fill color of the circular shapes in the wait indicator (e.g. “Red” or “#FF0000”).

Use the Branding.WaitIndicatorSecondaryColor key to change the border color of the circular shapes in the wait indicator.

Limitations

Product Name

The Branding.ProductName key value is not used when the application is launched in 'out-of-browser' mode (i.e. you have already installed the application to your desktop). There is a workaround which can address this but it requires modification to an installed program file:

Warning: The following procedure involves modifying a Dundas Dashboard XAP file.

  1. Locate Dundas.Dashboard.AppLoader.xap (default location is C:\Program Files\Dundas Data Visualization Inc\Dundas Dashboard\{InstanceName}\www\ClientBin) and create a backup copy of it.
  2. Change the file extension from .XAP to .ZIP and extract all the files to an empty temporary folder.
  3. Locate the AppManifest.xaml file in the temporary folder, and open it for editing in a text editor.
  4. Replace any occurrence of “Dundas Dashboard” in the OutOfBrowserSettings section with the desired text.
  5. Save and close the text editor.
  6. Select all the files in the temporary folder and add them to a new file named Dundas.Dashboard.AppLoader.zip.
  7. Rename Dundas.Dashboard.AppLoader.zip to Dundas.Dashboard.AppLoader.xap, then put this file in the original location (C:\Program Files\Dundas Data Visualization Inc\Dundas Dashboard\{InstanceName}\www\ClientBin).
  8. Uninstall and re-install the application shortcut to the desktop.

The product name is now updated in out-of-browser mode.

Related topics


Click to return to: Documentation

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

Copyright © 2009-2014 Dundas Data Visualization, Inc.