Install the ESB Management Portal Alert Service

Retired Content

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

The ESB Management Portal Alert Service is a sample service that notifies users of exceptions published to the ESB Management Portal. The service polls the exception database for new exceptions and evaluates these against exception alerts that users have created in the ESB Management Portal. The service then notifies any users or groups of users that have subscribed to the alert. The service retrieves notification e-mail addresses and group memberships from Active Directory. This service has no dependency on BizTalk Server.

To install the ESB Management Portal Alert Service

  1. Install and configure the ESB Portal as described in the previous section if you have not already done so.

  2. Open the Visual Studio solution named ESB.AlertService.sln from the \Source\Samples\Management Portal\ESB.AlertService folder and ensure that the <connectionStrings> section of the App.config file contains the correct connection strings for the EsbExceptionDb database:

    <connectionStrings>
      <add name="EsbExceptionDb"
           connectionString="Data Source=.; Initial Catalog=EsbExceptionDb;
                            Integrated Security=True" 
           providerName="System.Data.SqlClient"/>
    </connectionStrings>
    
  3. Build the ESB.AlertService.sln solution using the commands on the Build menu.

  4. Open Windows Explorer, navigate to the folder Source \Samples\Management Portal\ESB.AlertService.Install\Release\, and then run the Setup.exe** **file for the service.

  5. Leave all settings at their default values and click Next until the installer displays the user name and password values to configure the service account for the Alert Service. Select an account that is a member of the BizTalk Application Users group with access to both the EsbExceptionDb database and the server hosting the alert service. Enter the account name in the form: <DomainName>\<UserName>

  6. Use the Fault Settings page in the portal to configure the following settings in the Configuration table of the EsbExceptionDb database:

    • XsltPath. Point this setting to the folder containing the ESB Portal Alert Service (located by default within the \%Program Files%\Microsoft ESB Guidance Exception Notification Service 1.0 - November 2007 folder).
    • Enable Alert Queue Service. This setting indicates if the alert service should run and check for new exceptions occurring that match existing alerts.
    • Alert Queue Polling Interval. This setting is the number of milliseconds for the alert service to wait between processing batches of alerts.
    • Alert Queue Batch Size. This setting is the number of exceptions that the alert service should process as one operation and match against existing exceptions.
    • Alert Queue Active Directory Cache Interval. This setting is the interval at which the alert service should refresh its cache of Active Directory information, including e-mail addresses and group memberships.
    • LdapRoot. This setting is the LDAP connection string for your domain controller; for example, LDAP://servername.domain.com/DC=domain, DC=com.
    • Enable Alert Email Service. This setting indicates if the alert service should send alert e-mail messages. If you disable this option, the service will still process exceptions and store alerts in an outgoing e-mail queue table. You may prefer to use this scenario if you implement an alternative e-mail delivery service.
    • Email Server. This setting is the name of your e-mail server; for example, mail.domain.com.
    • Sender. This setting is the "From" e-mail address to use in alert e-mail messages.
    • Email Service Polling Interval. This setting is the number of milliseconds the e-mail service waits between sending each batch of e-mail messages.
    • Email Service Batch Size. This setting is the number of e-mail messages the e-mail service should process in a batch.
  7. Open the Services applet from the Administrative Tools section of your Start menu and locate the BizTalk ESB Exception Notification Service. Ensure that the start-up type is set to Automatic, and then start the service.

Now continue to the next task: Install the ESB Management Portal UDDI Publishing Service.