Application Definition File Reference
An application definition file (ADF) is used to build notification applications on the Notification Services platform. The ADF contains metadata that defines the application. This includes the structure of the events and subscriptions that the application accepts as input, and the structure of the notifications it produces.
Your ADF must be an XML file that conforms to the schema described in ApplicationDefinitionFileSchema.xsd, which is in the Microsoft SQL Server\90\NotificationServices\9.0.242\XMLSchemas folder. This schema describes all of the elements used when defining an application.
An ADF contains a hierarchy of XML elements, each containing text or other elements that specify the application settings and structure. The ADF must conform to the standards for well-formed XML, so all element names are case sensitive. Elements are specified using Pascal case, which means that the first character is uppercase and the first letter of any subsequent concatenated word is uppercase.
All element values must conform to XML naming conventions. For more information about these conventions, see XML Textual Content in the MSDN Library.
The following sections list the ADF XML element in the order they appear in an ADF. Not all elements can be used in one ADF. For sample ADF files, see Application Definition File Templates.
In This Section
| Element | Description |
|---|---|
Provides several samples ADFs for common application designs. |
|
Provides a Transact-SQL statement that specifies the action to be taken in an event chronicle rule. |
|
Provides a Transact-SQL statement that specifies the action to be taken in a subscription event rule. |
|
Provides a Transact-SQL statement that specifies the action to be taken in a scheduled subscription rule. |
|
Specifies an interval during which the Transact-SQL statements specified in the event chronicle Action element must complete. |
|
Specifies an interval during which the Transact-SQL statements specified in the subscription event Action element must complete successfully. |
|
Specifies an interval during which the Transact-SQL statements specified in the event scheduled Action element must complete successfully. |
|
Is the root element of an ADF. Contains all elements that describe a single Notification Services application. |
|
Contains elements that specify execution settings for the application. |
|
Provides a location to define a single initialization argument for a content formatter. |
|
Provides a location to define a single initialization argument for a hosted event provider. |
|
Provides a location for specifying the initialization arguments for a content formatter. |
|
Provides a location for specifying initialization values for a hosted event provider. |
|
Specifies the assembly that contains the custom content formatter class. |
|
Specifies the assembly that contains the class that implements the hosted event provider functionality. |
|
Specifies the build number of the application version number. |
|
Provides a location for specifying information about one event chronicle table. |
|
Provides a location for specifying information about one subscription chronicle table. |
|
ChronicleName Element for EventClass/Chronicles/Chronicle (ADF) |
Specifies the user-defined name of the event chronicle table. |
ChronicleName Element for SubscriptionClass/Chronicles/Chronicle (ADF) |
Specifies the user-defined name of the subscription chronicle table. |
Specifies how far the logical (quantum) clock can fall behind the real-time clock before skipping event chronicle rule firings. |
|
Provides a location for defining one or more Transact-SQL statements that maintain data in event chronicle tables. |
|
Provides a location for defining one or more Transact-SQL statements that determine the table structure for the chronicle tables used by the event class. |
|
Provides a location for defining one or more Transact-SQL statements that determine the table structure for the chronicle tables used by the subscription class. |
|
Specifies the class name of the class that provides the content formatter functionality. |
|
Specifies the class name of the class that provides the hosted event provider functionality. |
|
Specifies the collation of the database, which determines the languages it supports and the sort order in which query results are returned. |
|
Provides a location for defining a computed notification class field. |
|
Provides a location for all of the computed notification field definitions for one notification class. |
|
Contains elements that describe a condition action for a subscription class event rule or scheduled rule. |
|
Specifies the content formatter used by the associated notification class. |
|
Specifies the date the ADF was created. |
|
Specifies the time at which the ADF was created. |
|
Contains elements that define the application database. |
|
Specifies the name of the application database. |
|
Specifies one of the NamedFileGroup entries to be used as the default filegroup when creating SQL Server objects for this application. |
|
Indicates whether the associated notification class uses digest delivery. |
|
Indicates whether the value of the computed notification field is considered when grouping notifications for digest delivery. |
|
Indicates whether the value of the notification field is considered when grouping notifications for digest delivery. |
|
Provides a location for defining information about one of the distributors used by this application. |
|
Provides a location for specifying distributor logging settings for the application. These settings determine what types of notification delivery information gets logged. |
|
Provides a parent location for defining information about the distributors used by this application. |
|
Specifies how long the data removal process will continue to run after it has been started. |
|
Contains elements that define a single event class. |
|
Contains elements that define one or more event classes used by this application. |
|
Specifies the user-defined name of the event class. |
|
Specifies the event class with which the associated rule interacts. |
|
Provides the definition of a single subscription event rule. |
|
Provides a location for all of the subscription event rule definitions for one subscription class. |
|
Specifies the number of events that can be processed from a single event class during a single generator quantum. |
|
Specifies the amount of time to elapse before unsent messages of the associated notification class are considered to have expired. |
|
Specifies the minimum amount of time that must pass between writes to the event log, regardless of how many failures occur. |
|
Specifies the number of consecutive notification delivery failures that can occur when attempting to deliver a distributor work item before the attempt is aborted and an error is reported to the event log. |
|
Specifies the number of consecutive work item delivery failures that can occur before reporting an error to the event log. |
|
Provides a location for defining one event class field. |
|
Provides a location for defining one protocol header field. |
|
Provides a location for defining one notification class field. |
|
Provides a location for defining one subscription class field. |
|
Specifies the user-defined name of an event field. |
|
FieldName Element for NotificationClass/Schema/ComputedFields/ComputedField (ADF) |
Specifies the user-defined name of the computed notification field. |
FieldName Element for NotificationClass/Schema/Fields/Field (ADF) |
Specifies the user-defined name of the notification field. |
Specifies the user-defined name of a protocol field. |
|
Specifies the user-defined name of the subscription field. |
|
Provides a reference to a notification field for use in the protocol header. |
|
Provides a location for the protocol header field definitions needed for one of the protocols used by the associated notification class. |
|
Provides a location for all of the non-computed notification field definitions for one notification class. |
|
Specifies the SQL Server data type of the event field. |
|
FieldType Element for NotificationClass/Schema/Fields/Field (ADF) |
Specifies the SQL Server data type for a notification field. |
Specifies the SQL Server data type for a subscription field. |
|
Specifies optional SQL Server field attributes for an event field, such as null and default values. |
|
FieldTypeMods Element for SubscriptionClass/Schema/Field (ADF) |
Specifies optional SQL Server field attributes for a subscription field, such as null and default values. |
Specifies the SQL Server filegroup on which the event table will be created. |
|
Specifies the SQL Server filegroup on which the notification table will be created. |
|
Specifies the SQL Server filegroup on which the subscription class tables will be created. |
|
Specifies the user-defined name of the filegroup. |
|
Specifies the file name and path of a physical data file used by the application database. |
|
Specifies the file name and path of a log file used by the application database. |
|
Contains elements that define the application database's data files. |
|
Contains elements that configure the generator for this application. |
|
Specifies the increments by which the data file size will increase when additional space is needed. |
|
Specifies the increments by which the log file size will increase when additional space is needed. |
|
Contains elements that document the history of the ADF. |
|
Contains elements that define one hosted event provider. |
|
Contains Transact-SQL statements for creating one or more indexes on an event table. |
|
Contains Transact-SQL statements for creating one or more indexes on a subscription table. |
|
Specifies the view or table that contains input data for the condition action. |
|
Specifies the database schema name for the condition action's input. |
|
Specifies how frequently, after the initial start time, the event provider runs. |
|
Specifies the date the ADF was last changed. |
|
Specifies the time the ADF was last changed. |
|
Specifies whether the distributor makes an entry in the distribution log before delivering a notification. |
|
Contains elements that define the application database's log files. |
|
Specifies the logical name of an application database data file. |
|
Specifies the logical name of an application database log file. |
|
Configures the distributor to log all notification text from the delivery protocol for all notifications or just failed notifications. |
|
Specifies whether the distributor logs status information for all or just failed notifications. |
|
Specifies the major component of the application version number. |
|
Specifies the maximum size to which the data file can grow. |
|
Specifies the maximum size to which the SQL Server physical log file can grow. |
|
Specifies the minor component of the application version number. |
|
Indicates whether the associated notification class uses multicast delivery. |
|
Specifies the number of recipients that can receive a single multicast notification message. |
|
Specifies the name of an initialization argument for a content formatter. |
|
Specifies the name of an initialization argument for a hosted event provider. |
|
Specifies the name of an application parameter. |
|
Contains elements that describe a named filegroup and its database files. |
|
Provides a location for defining a non-hosted (independent) event provider that submits events to the application. |
|
For notifications not sent using digest delivery, NotificationBatchSize specifies the maximum number of notifications per batch for the notification class. For digest notifications, NotificationBatchSize specifies the number of notification batches that will be created. |
|
Provides a location for defining one notification class. |
|
Contains the definitions of all notification classes for the application. |
|
Specifies the user-defined name of the notification class. |
|
Specifies the number of notifications that can be produced per notification class from a single rule firing. |
|
Contains the definition of a single application parameter. |
|
Contains the definition of one or more parameters for the ADF. |
|
Specifies how frequently the application updates its performance counters. |
|
Specifies whether Notification Services uses quantum sequencing or subquantum sequencing to process event and subscription rules. |
|
Contains elements that define a delivery protocol used by the notification class to deliver notifications. |
|
Contains elements that define execution settings for one delivery protocol. |
|
Specifies the name of the delivery protocol. |
|
Contains elements that define one or more delivery protocols used by the notification class to deliver notifications. |
|
Specifies the user-defined name of the hosted event provider. |
|
Specifies the user-defined name of the non-hosted event provider. |
|
Specifies the database connection timeout for the hosted event provider. |
|
Contains elements that define the event providers used by the application. |
|
QuantumDuration Element for ApplicationExecutionSettings (ADF) |
Defines the length of time for a generator quantum, which determines how frequently the generator attempts to process work. |
Defines the length of time for a distributor quantum, which determines how frequently Notification Services invokes the distributor. |
|
Specifies the minimum age at which event and notification data is considered to be obsolete and available for removal. |
|
Specifies an interval for the distributor to wait before attempting to deliver failed notifications. |
|
Provides a location for defining the intervals at which to attempt to resend notifications if delivery attempts fail. |
|
Specifies the revision component of the application version number. |
|
Specifies the user-defined name of the event chronicle rule. |
|
Specifies the user-defined name of the subscription event rule. |
|
Specifies the user-defined name of the subscription scheduled rule. |
|
Contains elements that define the schedule for a hosted event provider. |
|
Specifies the schedule for the data removal process function. |
|
Contains elements that define a single subscription scheduled rule. |
|
Provides a location for all subscription scheduled rule definitions for one subscription class. |
|
Contains elements that define event class fields. |
|
Contains elements that define notification class fields. |
|
Contains elements that define subscription class fields. |
|
Specifies the database schema for all application database objects. |
|
Specifies the initial size of the application database. |
|
Specifies the initial size of the application log file. |
|
Specifies a valid Transact-SQL expression that provides the computed field value. |
|
Specifies the Transact-SQL query used to generate notifications from the input and subscription data. |
|
Specifies a valid Transact-SQL expression that provides the protocol field value. |
|
Specifies the SQL Server login account associated with the database user that runs condition actions. |
|
Contains the Transact-SQL statements that define an event chronicle table. |
|
SqlSchema Element for SubscriptionClass/Chronicles/Chronicle (ADF) |
Contains the Transact-SQL statements that define a subscription chronicle table. |
Contains a Transact-SQL statement for an event chronicle table. |
|
Contains a Transact-SQL statement that creates a SQL Server index for the event table. |
|
SqlStatement Element for SubscriptionClass/Chronicles/Chronicle/SqlSchema (ADF) |
Contains a Transact-SQL statement that defines a subscription chronicle table. |
SqlStatement Element for SubscriptionClass/IndexSqlSchema (ADF) |
Contains a Transact-SQL statement that creates a SQL Server index for the subscription table. |
Specifies the name of the database user used to run the condition action. |
|
Specifies a time of day (24 hour period) in Universal Coordinated Time (UTC) which is used as a starting point to calculate each of the invocation times for the event provider. |
|
Specifies the daily time, in UTC, for the data removal process to start. |
|
Contains the definition of one subscription class. |
|
Contains the definition of one or more subscription classes. |
|
Specifies the user-defined name of the subscription class. |
|
Specifies how far the logical (quantum) clock can fall behind the real-time clock before skipping subscription rule firings. |
|
Specifies the number of scheduled subscriptions that can be processed during a single generator quantum. |
|
Specifies the name of the server on which the distributor runs. |
|
Specifies the name of the server on which the generator runs. |
|
Specifies the name of the server on which the hosted event provider runs. |
|
Specifies the maximum number of threads that the distributor can use to process work items. |
|
Specifies the number of threads that the generator can use to concurrently process rules. |
|
Contains settings used by the data removal process, which removes obsolete event and notification data from the application database. |
|
Contains elements that define the vacuuming (data removal) schedule. |
|
Specifies the value of an initialization argument for a content formatter. |
|
Specifies the value of an initialization argument for a hosted event provider. |
|
Specifies the value of an application parameter. |
|
Contains elements that specify the current application version number. |
|
Specifies the amount of time a distributor thread can take to complete a work item assigned to it before the job is canceled and the work item is returned to the available work item pool. |
See Also
Reference
XML Declarations
XML Reserved Characters
Concepts
Instance Configuration File Reference
Other Resources
Defining Notification Services Applications