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

This site makes extensive use of JavaScript.

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

Configuring Email and Other Delivery Providers

Hide navigation
RSS
Modified on Wed, 27 Nov 2013 11:34 AM
Click to return to: Documentation | Installing and Administering Dundas Dashboard


Overview

A delivery provider is a Dundas Dashboard plugin/add-on that delivers notifications/alerts or scheduled reports in a specific format. Two built-in delivery providers are included with Dundas Dashboard:


This article provides instructions on manually configuring the email and UNC delivery providers, which are included in Dundas Dashboard as part of the notifications and scheduled reports features. This configuration should only be performed by the server administrator.

Tip: If you chose to configure Email Settings during the Dundas Dashboard installation procedure, the configuration of the Email Delivery provider should already be complete.

Email delivery provider

Plugin information

The email delivery provider is part of the Dundas Dashboard installation, and is one implementation of the delivery provider extensibility API. It handles the SMTP messaging required to send notification emails to a list of recipients.

Tip: watch the how-to-video: Configure Email Delivery Provider.

There are two plugins, which can be found in the following locations:

$WebsiteRoot\App_Data\Plugins\DeliveryProviderServer\EMailProvider.plugin
$WebsiteRoot\App_Data\Plugins\DeliveryProviderClient\EMailDeliveryProviderClient.plugin

If the plugins are not present, the email provider will not work correctly.

Configuration

The main configuration for the plugins is in the web application's main configuration file, Dundas.Dashboard.config, which is located in the root virtual directory for the site.

Here is the default email delivery provider configuration:



...



...



In the above configuration, the top-level key is pluginKey. This key specifies the ID of the Email delivery provider plugin and should not be changed. Note that if this key is commented out, you must uncomment it first before proceeding with the configuration.

Under the pluginKey key, you'll find the mailSettings configuration key, which is identical to the mailSettings key used in Microsoft .NET 4.0 application configuration for specifying a default SMTP server. There is documentation on the mailSettings configuration here: http://msdn.microsoft.com/en-us/library/w355a94k.aspx

Under the mailSettings key, you must set the following:

  • Change the host property to your company's SMTP server address.
  • Change the from property to an email account which is authorized to send emails on that server.

However, if you want to test the email delivery first without sending emails to other users, use the specifiedPickupDirectory option, which allows you to deliver the emails to a local directory on the server (⪚ for testing purposes). To do this, replace the mailSettings key with the following:



The customization key adds additional configuration options:

  • includeTimestampOnImage: If set to "True", the dashboard image, which is created by the image creation service and may be included with the notification email, will include a timestamp (see below).

Dashboard image, showing the timestamp.

Dashboard image, showing the timestamp.


Localization options

There are other strings appearing in the user interface (related to email delivery) which you can configure via the localization XML files under the $WebsiteRoot\App_Data\Localization folder.

Localization fileKeyDefault value         Description
EMailDeliveryProviderClient.base.xmlGS_TokenNameDashboardLinkDashboard linkNotifications optionally allow you to include a link to the dashboard which triggered the notification. This configuration key allows you to set the link text.
EMailDeliveryProviderClient.base.xmlGS_TokenNameDashboardImageDashboard imageIf the image creation service is configured on the server, users can include an image (in PNG format) of the dashboard along with the notification as an email attachment. This configuration key allows you to set the file name for the attachment (do not include the “.png” suffix, it will be added automatically).
EMailProvider.base.xmlGS_UnsubscribeLinkTextUnsubscribeEmails sent for notifications automatically contain an unsubscribe link. This key allows you to set the link text.

For more details about localization, see Multi-Language Support in Dundas Dashboard.

Configuring an email provider that requires authentication

If your SMTP server requires authentication you are able to specify a user name and password in the mail settings configuration. If your SMTP server requires authentication over SSL or TLS you will also have to specify the proper port number and include the enableSsl="True" option, as shown below:



Restart the Dundas Dashboard website

After making the changes to the Dundas Dashboard Configuration file, you must restart the Dundas Dashboard website in order for the changes to take effect.

UNC/file delivery provider

The UNC/file delivery provider allows notifications to be delivered in the form of a dashboard image file (PNG format) which is stored in a folder on your Dundas Dashboard server. This provider corresponds directly to the Create file delivery method option in the Notifications wizard.

Configuration

Here is the default UNC/file delivery provider configuration:



... ...



In the above configuration, the top-level key is pluginKey. This key specifies the ID of the UNC/file delivery provider plugin and should not be changed. By default, the entire pluginKey key is commented out. You must uncomment it in order to change its configuration.

Under the pluginKey key, the customization key provides the following configuration options:

  • includeTimestampOnImage: If set to "True", the dashboard image, which is created by the image creation service, will include a timestamp.
  • baseFolder: This is the base folder on your Dundas Dashboard server where dashboard images will be saved (if you specified a filename in the Notifications wizard instead of a full pathname).

After making the changes to the Dundas Dashboard Configuration file, you must restart the Dundas Dashboard website in order for the changes to take effect.

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-2016 Dundas Data Visualization, Inc.