Share via

Adding an Alert to the Web Element Database

  • Article

You can add custom messages, which can be displayed on the main status page of the Web UI.

To add custom messages to the main status page

  1. Add one Web element for each unique message.

  2. Use unique AlertLog and AlertID values in your Web element definition to define custom messages.

    One convention is to use the resource DLL name for the AlertLog value, and the CaptionRID value of the alert for the AlertID. A better convention is to use a unique string that is meaningful for the AlertLog and a number for the AlertID. For example, the framework uses ShutdownPending for AlertLog and 1 for AlertID for the shutdown pending alert.

Note The AlertLog and AlertID values in the Web element definition must match the values used when raising the alert. To provide the text displayed for the alert, default viewer maps the caption and description resource identifiers to the alert.

  1. Add the Web element definitions for the alert under the HKLM\Software\Microsoft\ServerAppliance\ElementManager\WebElementDefinitions registry key.

The following table illustrates such a Web element.

Value Type Description Example
ElementID Key Concatenation of "AlertDefinitions"<AlertLog> and <AlertID> AlertDefinitionsSampleResource.dll4C000004
CaptionRID String Resource identifier for the text of the alert link 4C000004
Container String Alert container AlertDefinitions
DescriptionRID String Resource identifier for the text to display on the alert details page 4C000008
ElementGraphic String Not applicable <empty>
IsEmbedded DWORD Instruction to process element as an embedded page 0x0
Merit DWORD Not applicable 0x0
Source String Name of resource DLL SampleResource.dll
URL String Must be empty to indicate that the default alert view must be used <empty>

Requirements

  • The Element identifier must be the string concatenation of the string ShutdownAlert-Definitions and the AlertLog and AlertID values.
  • The Container value must be AlertDefinitions.
  • The CaptionRID value must contain the resource identifier of the string that is the text for the link.
  • The DescriptionRID value must contain a more detailed description of the message.
  • The URL value must be empty to indicate that the default message view must be used.

Adding a Local UI Alert to the Web Element Database

Adding a Shutdown Alert to the Web Element Database

Extending an Alert with Hyperlinks

Raising And Displaying Alerts Overview

Raising and Displaying Alerts

Raising Alerts from Event Log Entries

Web Element Database