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.

Dundas Dashboard Configuration File

Hide navigation
RSS
Modified on Thu, 16 Oct 2014 02:57 PM Categorized as Configuration, Security
Click to return to: Documentation | Installing and Administering Dundas Dashboard

Table of Contents [Hide/Show]


Overview
   Restarting the Dundas Dashboard website
Dundas.Dashboard.config
    REQUIRED SETTINGS
       LicenseFilename
       AppDatabaseConnectionString
       SyncDatabaseConnectionString
       SecretKey
    OPTIONAL SETTINGS
       AccountServicesProviderFilename
       ActiveDirectoryBindingMode
       ActiveDirectoryDisplayNameProperty
       ActiveDirectoryEMailProperty
       AuthenticationMode
       AutoWindowsLoginEnabled
       ClientCommunicationTimeout
       DashboardPerformanceTrackingEnabled
       DashboardUsageTracking.IsEnabled
       DashboardUsageTracking.PingInterval
       DefaultCulture
       DomainMapping
       DundasDashboardUrl
       ExpandWindowsGroups
       GhostSessionTimeOut
       GroupServicesProviderFilename
       HideExceptionDetails
       ImageCreationServiceUrl
       ImageCreationImageFolderPath
       ImageCreationOutputCacheDuration
       ImageCreationExternalDataTimeout
       ImageCreationClientTimeout
       LicenseProviderFilename
       LogCategories
       LogFolder
       LogLevel
       LoginsEnabled
       LoginFailureDelayThreshold
       LoginFailureLockoutThreshold
       LoginTokenExpiryInterval
       MashupCreationEnabled
       MaxImageResourceSizeKb
       PasswordPolicy.AllowChange
       PasswordPolicy.AllowContainUsername
       PasswordPolicy.MinimumLength
       PasswordPolicy.RequireMixedAlphaNum
       PasswordPolicy.RequireMixedCase
       PasswordPolicy.RequireSymbol
       ResponseCompressionLevel
       SaveSessionInBrowserCache
       SessionTimeOut
       SessionTimeoutNamedLicenseHolders
       TenantIdAttributeName
       TenantConnectionStringAttributeName
       TrustedImageHosts
       UseWindowsImpersonation
       ValidateWindowsCredentialsMode
       ViewerPerformanceInfoButtonEnabled
    CACHE SETTINGS
       ClientCacheSlidingExpirationMinutes
       CacheSlidingExpirationMinutes
       DataCachingCommandTimeout
       MaxClientDataMemoryCacheItems
       MaxServerDataMemoryCacheItems
       ImportedFilesArchiveDuration
    SILVERLIGHT SETTINGS
       IsExtendedRightToLeftTextModeEnabled
       IsSilverlightPluginWindowless
       UseBrowserNetworkStack
    BRANDING SETTINGS
       Branding.AboutButtonCustomUri
       Branding.AboutLogoImageUri
       Branding.HelpButtonUriBase
       Branding.HtmlHomeLogoWeblinkUri
       Branding.HomeScreenWelcomeMessageText
       Branding.HomeScreenWelcomeMessageTitle
       Branding.LoginPageBackgroundSource
       Branding.LoginPageBackgroundImageStretch
       Branding.LoginPageLogoImageUri
       Branding.PrimaryLogoImageUri
       Branding.PrimaryLogoImageHorizontalAlignment
       Branding.ProductName
       Branding.ShowAboutButton
       Branding.WaitIndicatorImageUri
       Branding.WaitIndicatorPrimaryColor
       Branding.WaitIndicatorSecondaryColor
    PLUGIN SETTINGS
    SCHEDULER SETTINGS
       SchedulerPollingInterval
       SchedulerDundasCommunicationTimeout
    HTML SETTINGS
       HtmlEndSessionRedirectUrl
       HtmlViewerParallelRenderCount
       HtmlViewerCompressionForJSResource
       HtmlAutoLogin
       HtmlAutoLoginUsername
       HtmlAutoLoginPassword
       HtmlHomeDisableAnimation
       HtmlHomeLookAheadPages
       HtmlHomeLookBehindPages
       HtmlHomeMaxLoadingTileCount
       HtmlHomeUseStrictTileOrder
       HtmlHomeMaxLiveTileCount
       HtmlHomeRemoveContentOnReorder
       HtmlHomeIsDemoMode
Related topics


Overview

Dundas.Dashboard.config is an XML configuration file that provides settings to control Dundas Dashboard's behavior. Each setting consists of a key name and value. Key names are case-insensitive (as of version 4.0.0.1000 or later).

The XML file has the following basic format:

<?xml version="1.0"?>
<DundasDashboardConfiguration>
    ... Required settings ...

... Optional settings ... </DundasDashboardConfiguration>

The default path to this configuration file (on your Dundas Dashboard server) is:

C:\Program Files\Dundas Data Visualization Inc\Dundas Dashboard\{instance}\www\Dundas.Dashboard.config

Restarting the Dundas Dashboard website

Once you have completed changes to the Dundas Dashboard configuration file, you must restart the Dundas Dashboard website in order for the changes to take effect.

Dundas.Dashboard.config

REQUIRED SETTINGS

Dundas Dashboard requires these settings in its configuration file:

  • LicenseFilename
  • AppDatabaseConnectionString
  • SyncDatabaseConnectionString
  • SecretKey

Dundas Dashboard will not be able to start without these keys in its configuration file.

<?xml version="1.0"?>
<DundasDashboardConfiguration>

<!-- Application configuration file for Dundas Dashboard --> <!-- Note: any changes to this file require IIS to be restarted in order for the changes to take effect. -->

<!-- ############################################################################# # REQUIRED KEYS ############################################################################# -->

<!-- The location of the license file. The value may be an absolute path or a path relative to the application's root folder. --> <key name="LicenseFilename" value="C:\Program Files\Dundas Data Visualization Inc\Dundas Dashboard\Instance1\www\App_Data\Licenses\Dundas.Dashboard.lic" />

<!-- The connection string to the application database. --> <key name="AppDatabaseConnectionString" value="Data Source=localhost; Initial Catalog=Dundas Dashboard Instance1 DataStore; Integrated Security=True" />

<!-- The connection string to the synchronization database. --> <key name="SyncDatabaseConnectionString" value="Data Source=localhost; Initial Catalog=Dundas Dashboard Instance1 Sync; Integrated Security=True" />

<!-- The key to be used for creating and validating encrypted tokens. Note: Encrypted tokens are used for preventing unauthorized actions, such as unsubscribing arbitrary users from notifications. By default, it was generated as a random string. The key must be long and it's important that it remain secret. --> <key name="SecretKey" value="Replace this text with the application's secret key" />

LicenseFilename

The location of the license file. The value may be an absolute path or a path relative to the application's root folder.

Default: [[wwwroot]]\App_Data\Licenses\Dundas.Dashboard.lic

Note: This key is required in Dundas Dashboard 2.5.1 or later, but optional in earlier versions.

AppDatabaseConnectionString

The connection string used to contact the SQL Server database used for storing application data (e.g. projects, KPIs, dashboards, etc.).

Tip: You can use (local) or localhost to refer to a database server running on the same system as Dundas Dashboard.

SyncDatabaseConnectionString

The connection string used to contact the SQL Server database used for storing synchronized application data (e.g. cached virtual tables, temporary tables, etc.).

SecretKey

This key is used for creating and validating encrypted tokens. Encrypted tokens are used for preventing unauthorized actions, such as unsubscribing arbitrary users from notifications. The key must be long and it's important that it remain secret.

By default, the secretKey is generated as a GUID string when you install Dundas Dashboard.

OPTIONAL SETTINGS

These settings are optional; if they're not present, their default values will be used.

AccountServicesProviderFilename

The absolute path to an external account services provider.

Default: "" (none)

ActiveDirectoryBindingMode

The type of binding that will be used when communicating with Active Directory (AD). Value can be one of the following:

  • Default - The default binding will be used. Assumes all Windows users/groups belong to the same domain as the server where Dundas Dashboard is running.
  • Domain - A domain-specific binding will be used.
  • Extended - The Extended binding mode provides experimental support for nested AD group membership.
    Warning: The Extended binding mode has not been fully tested and is currently unsupported by Dundas Data Visualization, Inc.


Default: Default

ActiveDirectoryDisplayNameProperty

The name of the Active Directory property which contains the display name for a Windows account.

Default: displayName

ActiveDirectoryEMailProperty

The name of the Active Directory property which contains the email address for a Windows account.

Default: mail

AuthenticationMode

The authentication methods used by this Dundas Dashboard server. Can be set to:

  • Local - Use Dundas Dashboard (local) authentication only.
  • LocalAndWindows - Allow both Dundas Dashboard authentication and Windows authentication.
  • LocalAndWindowsExplicit - Allow both Dundas Dashboard authentication and Windows authentication. The username (e.g. DOMAINNAME\user) and password must be specified explicitly in the Login Screen.
  • Windows - Use Windows authentication only.

Default: Local

The application's login screen changes according to the authentication mode that is set.

Tip: Set to Local authentication mode if you want to use third-party authentication providers.

Note:
  • Windows authentication requires IIS 6 or higher.
  • Windows authentication is not installed with IIS 7; please refer to this article for more information about enabling Windows authentication in IIS7.


AutoWindowsLoginEnabled

A value indicating whether the automatic Windows login functionality should be enabled. Enabling this feature will cause the Login screen to attempt a Windows login the first time it is loaded during the lifetime of the Silverlight application. Note that this setting only applies if the AuthenticationMode setting is LocalAndWindows or Windows. Value can be one of the following:

  • True - Automatic Windows login is enabled.
  • False - Automatic Windows login is not enabled.

Default: True

ClientCommunicationTimeout

Specifies the maximum amount of time the client will wait to receive a response from the Dundas Dashboard server before throwing a communication exception.

Its value is of the format 'hh:mm:ss' and must lie in the interval [00:00:02 - 23:59:59] (i.e. greater than 1 second and less than 1 day).

Default: 00:02:00 (two minutes)

DashboardPerformanceTrackingEnabled

A value indicating whether the application will track dashboard performance information. The value can be one of the following:

  • True - The application will track dashboard performance.
  • False - The application will not track dashboard performance.

Default: False

Note: This key is available in Dundas Dashboard 5.0.2 or later.

DashboardUsageTracking.IsEnabled

A value indicating whether the application will track when and by whom a dashboard is viewed. The value can be one of the following:

  • True - The application will track dashboard usage.
  • False - The application will not track dashboard usage.

Default: False

DashboardUsageTracking.PingInterval

A value indicating how often the Dashboard client will send a message to the server to indicate that a dashboard is still being viewed, for the purpose of tracking usage. This value is measured in seconds.

Default: 30 (seconds)

DefaultCulture

The default culture of the application. Value can be either an IETF language tag (e.g. en-US), or the word Auto. If set to Auto, the default culture will be set to the culture of the web server process.

Default: Auto

DomainMapping

The domain mapping supports validation of Windows credentials when using Windows login. In certain cases validation of Windows credentials requires full domain or server name. While the Windows user is registered in the app in the Windows NT 4.0 account name format (e.g. “example\JeffSmith”), the validation process may require the full server name. The domain mapping supports multiple domain entries.

Example:

<domain name="example" value="example.com"/>

Note: This key is available in Dundas Dashboard 5.0.2 or later.

DundasDashboardUrl

The URL of the Dundas Dashboard application.

Example: http://dashserver:80/Dundas Dashboard Instance1/

ExpandWindowsGroups

A value indicating whether the "Add Users or Groups" dialog will list all members of any Windows group accounts defined in Dundas Dashboard. This dialog is shown when adding new security rights to an object. Value can be one of the following:

  • True - The list will contain all members of all Windows Group accounts defined in Dundas Dashboard.
  • False - The Windows User accounts shown in the list will be limited to those which have logged onto Dundas Dashboard at least once.

Default: False

GhostSessionTimeOut

The amount of time that a ghost session can remain idle before it is terminated automatically by the server. Values are specified as hh:mm:ss (hours:minutes:seconds) or d.hh:mm:ss (days.hours:minutes:seconds).

Default: 01:00:00 (one hour)

GroupServicesProviderFilename

The absolute path to an external group services provider.

Default: "" (none)

HideExceptionDetails

A value indicating whether exception details (such as stack traces) should be hidden from error messages in the UI. If set to True, the Details button will be hidden in error/exception dialogs.

Default: False

ImageCreationServiceUrl

The URL of the image creation service (on the image creation server). If this is not specified, or empty, then the image creation service is assumed to not be enabled.

Example: http://imgserver:8888/ImageCreationWebService/service

ImageCreationImageFolderPath

This folder should not be browsable by IIS, since that would be a serious security compromise. The folder will, however, require write-access by ASP.NET, as that will be the account producing the images.

Default: App_Data\DashboardImages

ImageCreationOutputCacheDuration

The duration (in seconds) that an image created via the image creation service should cache itself for. Any requests made via the ASPX page for this image during the duration will simply receive a cached copy. This key does not affect any API calls for an image.

Default: 60 (seconds)

ImageCreationExternalDataTimeout

The amount of time (in seconds) that the Silverlight image rendering app should wait for all external data sources (such as analytical controls, parameter controls, image control, RSS viewer, etc.) to complete their data call. This should be shorter than the windowsImageTimeout value defined for the Image Creation Windows Service.

Default: 10 (seconds)

ImageCreationClientTimeout

The maximum amount of time (in seconds) a client of the image creation web service should wait for the call to complete.

Default: 600 (seconds)

LicenseProviderFilename

The absolute path to an external license provider. If a value is specified for this key (e.g. you are using a custom license provider DLL), the value of the licenseFilename key must be set to an empty string.

Default: "" (none)

LogCategories

A comma-separated list of application action categories that will produce log entries. Possible values:

  • Application
  • Business
  • Client
  • Data
  • Framework
  • General
  • Security

Tip: Setting LogCategories to an empty string enables all logging messages.

Default: "" (all messages)

LogFolder

The folder in which to store log files.

If the folder contains a colon or starts with '\\', it will be treated as an absolute path. Otherwise, it will be treated as a path relative to the root folder of the Dundas Dashboard web site.

The log file is an XML document and is accompanied by an underlying data file. The log file is best viewed using an XML reader, such as Internet Explorer.

Examples:

  • App_Data/Logs (default)
    This path is relative to a root folder such as C:\Program Files\Dundas Data Visualization Inc\Dundas Dashboard\Instance1\www.
  • C:\temp\logs
    An absolute path on the Dundas Dashboard web server.
  • \\server1\share\logs
    An absolute network path.

LogLevel

The level of detail for logging. One of:

  • Critical - Fatal errors and application crashes.
  • Error - Recoverable errors.
  • Warning - Non-critical problems.
  • Information - Informational messages.
  • Verbose - Maximum trace logging.

Each LogLevel automatically enables the levels above it. For example, non-critical problems, recoverable errors and fatal errors are all logged when set to Warning.

Default: Critical

LoginsEnabled

Whether users are allowed to log in to the system. Users with Administration privileges are not affected by this setting. Must be set to True or False.

Default: True

LoginFailureDelayThreshold

The number of consecutive login failures after which a delay will be injected into the process of logging in to that local user's account. The default value is zero, which implies no delay will be injected.

Default: 0

LoginFailureLockoutThreshold

The number of consecutive login failures that will cause a local user account to be disabled. The default value is zero, which implies that no amount of consecutive login failures will cause local user accounts to be disabled.

Default: 0

LoginTokenExpiryInterval

The time after which a login token expires. Values are specified as hh:mm:ss (hours:minutes:seconds), or d.hh:mm:ss (days.hours:minutes:seconds).

Default: 01:00:00 (one hour)

MashupCreationEnabled

A value indicating whether users are permitted to create mashups. Must be set to True or False.

Default: True

MaxImageResourceSizeKb

The maximum size of an image resource in kilobytes.

Default: 200 (200 KB)

PasswordPolicy.AllowChange

A value indicating whether users are allowed to change their password. Value may be one of the following:

  • True - Users are allowed to change their password.
  • False - Users may not change their password; it must be done by an administrator.

Default: True

PasswordPolicy.AllowContainUsername

A value indicating whether a local user's password may contain the username as a substring.

Default: False

PasswordPolicy.MinimumLength

The minimum length of a local user's password. A value of 0 indicates there is no minimum length.

Default: 0

PasswordPolicy.RequireMixedAlphaNum

A value indicating whether a local user's password must contain at least one letter and one number.

Default: False

PasswordPolicy.RequireMixedCase

A value indicating whether a local user's password must contain at least one uppercase letter and one lowercase letter.

Default: False

PasswordPolicy.RequireSymbol

A value indicating whether a local user's password must contain at least one symbol character (i.e. any character on your keyboard that is not a letter, number, or whitespace).

Default: False

ResponseCompressionLevel

The level of compression that the server should use when responding to client requests. This is an integer value between 0 and 9 inclusive:

  • 0 - No compression.
  • 1 - Minimal compression (low CPU usage).
  • 9 - Maximum compression (high CPU usage).

Usually level 5 provides the best balance of compression to CPU usage.

Default value: 5 (moderate compression)

SaveSessionInBrowserCache

A value indicating whether a user's session information is saved in the web browser. If enabled, the user will not have to log in again if the page is reloaded or the web browser is restarted (assuming the user's session has not timed out).

  • True - The user's session ID is cached (default).
  • False - The user's session ID is not cached.

Default: True

Note: If this setting is disabled, the user's session ID will be stored in a session cookie for HTML instead of a persistent cookie. This means that if a user enables features in their browser to restore the previous state when it is restarted (e.g. Chrome's “Continue where I left off” option for the “On startup” setting), then the session cookies used in the HTML viewer will continue to exist when the browser is restarted.

SessionTimeOut

The maximum amount of time a session can remain idle before it is automatically ended by the Dashboard server. Values are specified as hh:mm:ss (hours:minutes:seconds), or d.hh:mm:ss (days.hours:minutes:seconds). Use the value infinite if you don't want the session to time out.

Default: 01:00:00 (one hour)

SessionTimeoutNamedLicenseHolders

The maximum amount of time a session for an account with a named license can remain idle before it is automatically ended by the Dashboard server. Values are specified as hh:mm:ss (hours:minutes:seconds), or d.hh:mm:ss (days.hours:minutes:seconds). Use the value infinite if you don't want the session to time out.

Default: infinite (no timeout)

TenantIdAttributeName

The custom attribute name that is used to store the TenantId value for each logged-in user.

Default: ""

TenantConnectionStringAttributeName

The custom attribute name that is used to store connection string details for each logged-in user.

Default: ""

TrustedImageHosts

This key lists the URLs that can be used to retrieve images using GetImage.aspx. Leave the key commented out to allow any URL (which is the default behavior).

Example:

<key name="TrustedImageHosts">
  <host>http://example.com</host>
</key>

Note: This key is available in Dundas Dashboard 5.0.3 Revision 4 or later.

UseWindowsImpersonation

Indicates whether Windows Impersonation will be used.

Default: False

Related article:


ValidateWindowsCredentialsMode

The mode used to validate Windows credentials when using Windows login. Value can be one of the following:

  • ADSNameNT4 - Validation uses Windows NT 4.0 account name format. For example, “example\JeffSmith”.
  • ADSNameDomainSimple - Validation uses simple domain name format. For example, “JeffSmith@example.com”.
  • DomainNotUsed - Validation does not use domain, only user name. For example, “JeffSmith”.
  • KerberosOnlyValidation - Validation uses only Kerberos authentication type, does not fall back to NTLM in the event of failure.

Default: ADSNameNT4

Note: This key is available in Dundas Dashboard 5.0.2 or later.

ViewerPerformanceInfoButtonEnabled

Whether the Performance Info button will be displayed in the Viewer window within Dundas Dashboard. Must be either True or False.

Default: False

CACHE SETTINGS

These settings control data caching on both the Dashboard server and the client.

ClientCacheSlidingExpirationMinutes

Client-side business object cache, with a sliding expiration expressed in minutes. Objects which have been cached on the client within this time window will not be updated from the server. A value of 0 indicates that the client should always check with the server to ensure its cached objects are not stale.

Default: 0

CacheSlidingExpirationMinutes

Specifies the maximum amount of time, in minutes, that business objects will be cached in the Dashboard server.

Default: 60 (one hour)

DataCachingCommandTimeout

Command timeout for sync database data caching queries, in seconds. The same value should be set in the Scheduler configuration file.

Default: 300 (five minutes)

MaxClientDataMemoryCacheItems

The maximum number of items that can be contained in the memory data cache on the client. The default behavior is unlimited items (if the key is not present). A value of -1 will also allow unlimited items to be stored. A value of 0 will disable memory data caching application wide.

Example: 2000 (items)

MaxServerDataMemoryCacheItems

The maximum number of items that can be contained in the memory data cache on the server. The default behavior is unlimited items (if the key is not present). A value of -1 will also allow unlimited items to be stored. A value of 0 will disable memory data caching application wide.

Example: 10000 (items)

ImportedFilesArchiveDuration

Number of days for keeping imported files archive. When archived file is older, it will be deleted.

Default: 30 (days)

SILVERLIGHT SETTINGS

These settings control Silverlight features on the client.

IsExtendedRightToLeftTextModeEnabled

A value indicating whether controls in the Silverlight user interface should behave differently in order to better accommodate right-to-left text input. Currently, this setting only affects whether the CTRL+Shift key combination will switch the text direction of a text input box. Value can be one of the following:

  • True - Extended right-to-left text mode is enabled.
  • False - Extended right-to-left text mode is disabled (default).

Default: False

IsSilverlightPluginWindowless

A value indicating whether the Silverlight plugin is in windowed or windowless mode. The default and recommended value is false (i.e. windowed mode). Windowless mode is usually required when mixing HTML and Silverlight content and has significant implications such as a decrease in performance.

For more information, see this MSDN article.

Default: false

UseBrowserNetworkStack

The network stack which Silverlight will use to make HTTP requests to the Dundas Dashboard server. The value can be one of the following:

  • True - The web browser's network stack will be used.
  • False - Silverlight's native client network stack will be used (experimental, results in better performance).

Note: This setting does not have any effect if Silverlight is running outside the browser.

Default: False

BRANDING SETTINGS

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

All image URIs in these settings follow these conventions:

  • Use an empty string ("") to indicate that no image should be shown.
  • Use {x:Null} to indicate that the default image should be used.
  • The scheme of this URI must match the scheme which is used to access the application (http or https).
  • URIs must be absolute (for example, http://www.dundas.com/images/sonatica.png).
  • Supported image formats are PNG and JPEG.

Note: Image URIs must be accessible from the Dundas Dashboard server. Test your image URIs for this before making any changes to the configuration file. If your images are on the Dundas Dashboard server, you can try using localhost in your image URLs, for example.

Branding.AboutButtonCustomUri

The absolute URI of a web page which will be launched when the user clicks on the About button, instead of showing the built-in about dialog. The scheme of the URI must be http or https.

Default: {x:Null}

Branding.AboutLogoImageUri

An absolute URI pointing to an image which will be shown in the About dialog. The dimensions of the image should be 386x201 pixels. Can be used as an alternative to the Branding.AboutButtonCustomUri key.

Default: {x:Null}

Branding.HelpButtonUriBase

The absolute URI of a web page which will be launched (with context-sensitive information in the query string) when the user invokes the online help functionality of the application. The scheme of the URI must be http or https. You can specify an empty string to hide the help button.

Default: http://support.dundas.com/GetHelp.aspx

Branding.HtmlHomeLogoWeblinkUri

The absolute URI of a web page that will be launched when the user clicks on the application logo in the top-left corner of the HTML Explorer/Home. The scheme of the URI must be http or https.

Default: {x:Null}

Note: This key is available in Dundas Dashboard 5.0.2 or later.

Branding.HomeScreenWelcomeMessageText

The text of the welcome message which appears in the home screen of the application. Specify {x:Null} to use the default value, or an empty string to disable the welcome message.

You can format the text using certain HTML tags in the Branding.HomeScreenWelcomeMessageText if you encode the < and > characters as &#60; and &#62; respectively. See Formatting Rich Text for a list of supported HTML tags.

Default: {x:Null}

Branding.HomeScreenWelcomeMessageTitle

The text shown in the title of the welcome message which appears in the home screen of the application.

You must HTML-encode these characters to use them in Branding.HomeScreenWelcomeMessageTitle: <, >, /, \, "

Default: Welcome to Dundas Dashboard

Branding.LoginPageBackgroundSource

A value indicating what should be shown as the background for the startup and login screens. Value can be one of the following:

  • The URL to an image.
  • A color specification in the following format: {color:color}, where color is the name or hex value of the color to use in place of the default for the radial gradient fill.
  • A color specification in the following format: {solidcolor:color}, where color is the name or hex value of the solid color to use as the fill.
  • An empty string, indicating that the default color should be used.

Default: ""

Examples:

<key name="Branding.LoginPageBackgroundSource" value="http://www.dundas.com/MyImage.png" />
<key name="Branding.LoginPageBackgroundSource" value="{color:Blue}" />
<key name="Branding.LoginPageBackgroundSource" value="{color:#FF929292}" />
<key name="Branding.LoginPageBackgroundSource" value="{solidcolor:#FF929292}" />

Branding.LoginPageBackgroundImageStretch

A value indicating how the image specified by the Branding.LoginPageBackgroundImageSource setting should be stretched. Value can be an empty string (indicating the default should be used), or one of the following:

  • None - The image will be shown at its original size.
  • Fill - The image is resized to fit the screen; the aspect ratio is not preserved.
  • Uniform - The image is resized to fit the screen, preserving the aspect ratio.
  • UniformToFill - The image is resized to fit the screen, preserving the aspect ratio. If the aspect ratio of the image differs from that of the screen, the image is clipped to fit.

Default: ""

Branding.LoginPageLogoImageUri

An absolute URI pointing to an image which will be shown on the login page. The dimensions of the image should be 200x60 pixels.

Default: {x:Null}

Branding.PrimaryLogoImageUri

An absolute URI pointing to an image which will be shown in the top-left corner of the application. The dimensions of the image should be 145x50 pixels.

Default: {x:Null}

Branding.PrimaryLogoImageHorizontalAlignment

A horizontal alignment of the image specified by the Branding.PrimaryLogoImageUri key. Value can be one of the following:

  • Left - The image will be aligned to the left in the available space.
  • Center - The image will be centered in the available space.
  • Right - The image will be aligned to the right in the available space.

Default: Center

Branding.ProductName

The product name as it appears in the application.

Default: Dundas Dashboard

Branding.ShowAboutButton

A value indicating whether the About button should be shown in the toolbar. Specify True or False.

Default: True

Branding.WaitIndicatorImageUri

An absolute URI pointing to an image which will be shown in the center of the wait indicator. The dimensions of the image should be less than 50x50.

Default: {x:Null}

Branding.WaitIndicatorPrimaryColor

The fill color of the circular shapes in the wait indicator. Specify an empty string to use the default value. Colors can be specified as a hex color code, a comma-separated list of RGB values, or the name of a color.

Default: ""

Branding.WaitIndicatorSecondaryColor

The border color of the circular shapes in the wait indicator. Specify an empty string to use the default value. Colors can be specified as a hex color code, a comma-separated list of RGB values, or the name of a color.

Default: ""

PLUGIN SETTINGS

This section contains optional configuration settings for plugins.

Below is an example configuration for the Email Delivery Provider plugin:

<!-- Sample configuration for email delivery provider plugin -->
  <pluginKey id="{4020ACC2-8681-4158-B595-E3AAC2623FFB}">
    <mailSettings>
      <smtp deliveryMethod="network" from="myname@mycompany.com">
        <network host="smtp.mycompany.com" />
      </smtp>
    </mailSettings>
    <customization includeTimestampOnImage="true" />
  </pluginKey>
  <!-- Sample configuration for UNC delivery provider plugin. 
  -->
  <!--
  <pluginKey id="{5298B3E3-4C07-4372-8CC9-60BFD7F25409}">
    <customization
      includeTimestampOnImage="true"
      baseFolder="C:\Temp"
    />
  </pluginKey>
  -->

SCHEDULER SETTINGS

SchedulerPollingInterval

The time interval between polls for pending scheduled tasks (in milliseconds).

Default: 60000 (1 minute)

SchedulerDundasCommunicationTimeout

Specifies the maximum amount of time the client will wait to receive a response from the Dundas Dashboard server.

Its value is of the format 'hh:mm:ss' and must lie in the interval [00:00:02 - 23:59:59] (i.e. greater than 1 second and less than 1 day).

Default: 00:01:00 (1 minute)

HTML SETTINGS

HtmlEndSessionRedirectUrl

Specifies the URL to redirect when session expiration occurs or user clicks log out.

Default: ""

HtmlViewerParallelRenderCount

The number of dashboards that can be rendered in parallel by the html viewer.

Default: 8

HtmlViewerCompressionForJSResource

Enable compression for the JavaScript resource file.

Default: False

HtmlAutoLogin

Specifies whether the html framework will perform an automatic login. This setting is only valid for non-Windows users (e.g. local user accounts in Dundas Dashboard). To automatically log in Windows users see the AutoWindowsLoginEnabled configuration setting.

Default: False

HtmlAutoLoginUsername

Specifies the username used for the auto login.

Default: user

HtmlAutoLoginPassword

Specifies the password used for the auto login.

Default: password

HtmlHomeDisableAnimation

Flag to disable the animations on the html home screen.

Default: False

HtmlHomeLookAheadPages

The number of following tile pages to preload. If there are more tiles than fit on one screen only the visible ones are loaded. This setting can be used to control how many pages ahead are preloaded. Values don’t have to be rounded (e.g. 0.5 is a valid value).

This setting allows administrators to find a balance between server load and HTML home screen responsiveness. Changing this should only be necessary though under heavy home screen use combined with complex tiles.

Default: 1

HtmlHomeLookBehindPages

The number of previous tile pages to preload. If there are more tiles than fit on one screen only the visible ones are loaded. This setting can be used to control how many pages behind are preloaded. Values don’t have to be rounded (i.e. 0.5 is a valid value).

This setting allows administrators to find a balance between server load and HTML home screen responsiveness. Changing this should only be necessary though under heavy home screen use combined with complex tiles.

Default: 1

HtmlHomeMaxLoadingTileCount

The maximum number of simultaneously loading tiles.

This setting controls the number of concurrently loading tiles. When more tiles are loaded concurrently, the HTML home screen generally loads faster. The disadvantage is that on lower spec machines, smartphones and tablets, the browser may be less responsive. Additionally, the load on the server is greater, especially if there are many concurrent users.

Default: 1

HtmlHomeUseStrictTileOrder

Flag to indicate that the tiles should use strict order (leave gaps).

The HTML home screen tries to make use of the available space when laying out tiles. As a result, 1x1 tiles can be placed before larger tiles in an attempt to make use of the available space. This setting can be used in the situation when this behavior is not desired, and the tiles should be placed in the same order as specified in the HTML Home Settings screen or by user re-arrangements, regardless of the available real estate.

Default: False

HtmlHomeMaxLiveTileCount

The maximum number of rendered live data tiles.

This setting can be used to limit the number of live tiles (tile row and column span > 0) that are loaded at the same time. When there are too many live tiles on a home screen, this can cause browser unresponsiveness, especially on lower spec devices. As a side effect, when the user scrolls tiles that were previously loaded, the tiles will be emptied so that the immediately visible tiles are loaded.

Default: 25

HtmlHomeRemoveContentOnReorder

Flag to indicate that the content should be removed during reorder.

This setting affects the HTML home screen's Configure mode. When the home screen has many live tiles, dragging them around can result in a significant hit to browser responsiveness. This setting can be used to remove the content when in Configure mode. The side effect is that, when returning to the view mode, the tiles will have to reload their content.

Default: False

HtmlHomeIsDemoMode

Flag to enable demo mode on the HTML home screen. When demo mode is enabled, home screen layout changes are stored in the session instead of being persisted with the user profile. This lets you present the same default or initial view to users when they log in (since any layout changes are discarded when the session is ended).

Default: False

Related topics


Click to return to: Documentation | Installing and Administering Dundas Dashboard

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

Copyright © 2009-2014 Dundas Data Visualization, Inc.