Export (0) Print
Expand All

AlertTemplates schema

Last modified: July 15, 2011

Applies to: SharePoint Foundation 2013 | SharePoint Server 2013

Microsoft SharePoint Foundation includes a set of predefined alert templates. These alert templates are stored in the Alerttemplates.xml file, which is located in the %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML folder. Alerttemplates.xml defines the format, contents, filters, event types and properties used to create alert messages from each list type. A developer can customize alerts by modifying a copy of the Alerttemplates.xml file and then loading the customized alert templates by using the command stsadm -o updatealerttemplates.

Alert templates also define what filters and event types appear on the new alert and edit alert pages (the subnew.aspx and subedit.aspx pages)

Note Note

Do not modify the Alerttemplates.xml file. Doing so may result in loss of functionality when upgrading or installing service packs.

For a listing of the predefined alert templates, see Predefined Alert Templates.

AlertTemplates

  AlertTemplate

    EventTypes

    Format

      Digest

      Header

      HeaderFields

      Subject

      HeaderFieldsHeader

      HeaderFieldsFooter

      RowHeader

      RowFields

      RowFooter

      Footer

      Immedate

      Fields

    Properties

      DigestNotificationExcludedFields

      ImmediateNotificationExcludedFields

      NotificationHandlerAssembly

      NotificationHandlerClassName

      UpdateHandlerAssembly

      UpdateHandlerClassName

    Filters

      FilterDefinition

        FriendlyName

        ShortName

        Query

The following example shows the basic elements in an alert templates schema.

<AlertTemplates>
  <AlertTemplate Type="List" Default="True" Name ="Default Template">
  </AlertTemplate>
  <AlertTemplate Type="List" Name="SPAlertTemplateType.GenericList">
    <EventTypes IsVisible="True"/>
    <Format>
    </Format>
    <Properties>
    </Properties>
    <Filters>
      <FilterDefinition>
      </FilterDefinition>
    </Filters>
  </AlertTemplate>
</AlertTemplates>

Show:
© 2014 Microsoft