Instance Configuration File Reference
An instance configuration file (ICF) is a structured XML file that describes a single instance of SQL Server 2005 Notification Services. The ICF lists the Notification Services applications hosted by the instance and also contains metadata about the instance, its delivery protocols and delivery channels, and its database server.
The ICF must conform to the ConfigurationFileSchema.xsd schema, which is in the Notification Services XMLSchemas folder.
The elements in the ICF are described in this reference section. Use the links below to access information about an ICF element.
Configuration File Conventions
The following rules apply to all elements in the instance configuration file:
- Element names are case-sensitive.
- The elements in the configuration file must appear in the order defined by the schema. For an example, see Complete ICF Template.
- Optional element groups can be removed or can contain empty child elements.
In This Section
| Topic | Description |
|---|---|
Contains templates for developing ICFs. |
|
Contains elements that describe a single notification application. |
|
Specifies the file name of the application definition file (ADF), and optionally its relative path. |
|
Is the logical name of the application. |
|
Contains one or more Application elements, each of which describes one application hosted by the instance. |
|
Contains one name/value pair that provides a value for a delivery channel argument. |
|
Contains one or more Argument elements that specify name/value pairs for delivery channel arguments. |
|
Is the path and file name of the assembly that contains the delivery protocol class. |
|
Is the path of the application folder, which contains application-related files such as the ADF, XML, and XSLT files. |
|
Is the build number, which is the third number in the product version string. |
|
Is the class name for the delivery protocol, which is within the assembly specified by the AssemblyName element. |
|
Specifies the collation of the database, which determines the languages supported by the database, and the sort order in which query results are returned. |
|
Is the date that the configuration file was created. |
|
Provides the time that the configuration file was created. |
|
Contains elements that specify database parameters for the instance database. The Database element contains elements that describe filegroups, the database files in those filegroups, and the database log. |
|
Specifies the name of the instance database. |
|
Specifies one of the NamedFileGroup values to be used as the default filegroup when creating SQL Server objects for the instance. |
|
Contains elements that describe the properties of a single delivery channel instance. |
|
Is the logical name of the delivery channel. |
|
Contains one or more DeliveryChannel elements that describe all the delivery channels used by all applications hosted by the instance. |
|
Specifies whether the instance encrypts delivery channel and event provider arguments before storing the values in the instance and application databases. |
|
Provides the name of one filegroup used by the instance database. |
|
Provides the path and file name used by the operating system when it creates a database file. |
|
Is the path and file name used by the operating system when it creates a log file. |
|
Contains elements that describe the properties of one database file. |
|
Is the amount of space that is added to the database file each time new space is needed. |
|
Is the amount of space that is added to the log file each time new space is needed. |
|
Contains elements that provide the date and time of the configuration file's creation and last modification. |
|
Provides the logical name for the instance of Notification Services. |
|
Provides the date the configuration file was last modified. |
|
Provides the time the configuration file was last modified. |
|
Contains elements that define one log file. |
|
Provides the name used to refer to the database file. |
|
Is the name used to refer to the log file. |
|
Is the major version number, which is the first number in the product version string. |
|
Provides the maximum size to which the database file can grow. |
|
Is the maximum size to which the log file can grow. |
|
Is the minor version number, which is the second number in the product version string. |
|
Is the name of a parameter to be passed to the ADF. |
|
Is the name of one argument to be passed to the delivery channel. |
|
Is the name of the parameter. |
|
Contains elements that describe a filegroup used by the database. |
|
Root element of a configuration file. |
|
Contains one name/value pair that provides a value for a parameter in the ADF. |
|
Contains one name/value pair that provides a default value for a parameter in the configuration file. |
|
Contains one or more Parameter elements, which contain default values for replaceable parameters. |
|
Contains an application-specific set of parameters that are passed to the ADF. |
|
Contains elements that describe a single custom delivery protocol. |
|
Is the name of the protocol, either standard or custom, used by the delivery channel. |
|
Is the name of a custom delivery protocol. |
|
Contains one or more Protocol elements, each of which describes a custom delivery protocol used to deliver messages. |
|
Is the revision number, which is the fourth number in the product version string. |
|
Specifies the database schema for all instance database objects. |
|
Provides the initial size of the database file. |
|
Is the initial size of the log file. |
|
Provides the name of an instance of SQL Server that hosts the Notification Services instance database and its application databases. |
|
Is the value of a parameter passed to the ADF. |
|
Is the value of one argument passed to the delivery channel. |
|
Is the value of the parameter. |
|
Contains elements that provide the Notification Services version number used by the instance. |
See Also
Reference
XML Declarations
Application Definition File Reference
Concepts
Instance Configuration File Templates
Other Resources
Configuring Instances of Notification Services