Instance Configuration File Reference

Switch on low bandwidth view

Community Content

In this section

Statistics Annotations (0)

Click here to expand

Collapse All

SQL Server 2005 Books Online (November 2008)

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
Instance Configuration File Templates	Contains templates for developing ICFs.
Application Element (ICF)	Contains elements that describe a single notification application.
ApplicationDefinitionFilePath Element (ICF)	Specifies the file name of the application definition file (ADF), and optionally its relative path.
ApplicationName Element (ICF)	Is the logical name of the application.
Applications Element (ICF)	Contains one or more Application elements, each of which describes one application hosted by the instance.
Argument Element (ICF)	Contains one name/value pair that provides a value for a delivery channel argument.
Arguments Element (ICF)	Contains one or more Argument elements that specify name/value pairs for delivery channel arguments.
AssemblyName Element (ICF)	Is the path and file name of the assembly that contains the delivery protocol class.
BaseDirectoryPath Element (ICF)	Is the path of the application folder, which contains application-related files such as the ADF, XML, and XSLT files.
Build Element (ICF)	Is the build number, which is the third number in the product version string.
ClassName Element (ICF)	Is the class name for the delivery protocol, which is within the assembly specified by the AssemblyName element.
CollationName Element (ICF)	Specifies the collation of the database, which determines the languages supported by the database, and the sort order in which query results are returned.
CreationDate Element (ICF)	Is the date that the configuration file was created.
CreationTime Element (ICF)	Provides the time that the configuration file was created.
Database Element (ICF)	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.
DatabaseName Element (ICF)	Specifies the name of the instance database.
DefaultFileGroup Element (ICF)	Specifies one of the NamedFileGroup values to be used as the default filegroup when creating SQL Server objects for the instance.
DeliveryChannel Element (ICF)	Contains elements that describe the properties of a single delivery channel instance.
DeliveryChannelName Element (ICF)	Is the logical name of the delivery channel.
DeliveryChannels Element (ICF)	Contains one or more DeliveryChannel elements that describe all the delivery channels used by all applications hosted by the instance.
EncryptArguments Element (ICF)	Specifies whether the instance encrypts delivery channel and event provider arguments before storing the values in the instance and application databases.
FileGroupName Element (ICF)	Provides the name of one filegroup used by the instance database.
FileName Element for FileSpec (ICF)	Provides the path and file name used by the operating system when it creates a database file.
FileName Element for LogFile (ICF)	Is the path and file name used by the operating system when it creates a log file.
FileSpec Element (ICF)	Contains elements that describe the properties of one database file.
GrowthIncrement Element for FileSpec (ICF)	Is the amount of space that is added to the database file each time new space is needed.
GrowthIncrement Element for LogFile (ICF)	Is the amount of space that is added to the log file each time new space is needed.
History Element (ICF)	Contains elements that provide the date and time of the configuration file's creation and last modification.
InstanceName Element (ICF)	Provides the logical name for the instance of Notification Services.
LastModifiedDate Element (ICF)	Provides the date the configuration file was last modified.
LastModifiedTime Element (ICF)	Provides the time the configuration file was last modified.
LogFile Element (ICF)	Contains elements that define one log file.
LogicalName Element for FileSpec (ICF)	Provides the name used to refer to the database file.
LogicalName Element for LogFile (ICF)	Is the name used to refer to the log file.
Major Element (ICF)	Is the major version number, which is the first number in the product version string.
MaxSize Element for FileSpec (ICF)	Provides the maximum size to which the database file can grow.
MaxSize Element for LogFile (ICF)	Is the maximum size to which the log file can grow.
Minor Element (ICF)	Is the minor version number, which is the second number in the product version string.
Name Element for Application/Parameters/Parameter (ICF)	Is the name of a parameter to be passed to the ADF.
Name Element for DeliveryChannel/Arguments/Argument (ICF)	Is the name of one argument to be passed to the delivery channel.
Name Element for ParameterDefaults/Parameter (ICF)	Is the name of the parameter.
NamedFileGroup Element (ICF)	Contains elements that describe a filegroup used by the database.
NotificationServicesInstance Element (ICF)	Root element of a configuration file.
Parameter Element for Application/Parameters (ICF)	Contains one name/value pair that provides a value for a parameter in the ADF.
Parameter Element for ParameterDefaults (ICF)	Contains one name/value pair that provides a default value for a parameter in the configuration file.
ParameterDefaults Element (ICF)	Contains one or more Parameter elements, which contain default values for replaceable parameters.
Parameters Element (ICF)	Contains an application-specific set of parameters that are passed to the ADF.
Protocol Element (ICF)	Contains elements that describe a single custom delivery protocol.
ProtocolName Element for DeliveryChannel (ICF)	Is the name of the protocol, either standard or custom, used by the delivery channel.
ProtocolName Element for Protocol (ICF)	Is the name of a custom delivery protocol.
Protocols Element (ICF)	Contains one or more Protocol elements, each of which describes a custom delivery protocol used to deliver messages.
Revision Element (ICF)	Is the revision number, which is the fourth number in the product version string.
SchemaName Element (ICF)	Specifies the database schema for all instance database objects.
Size Element for FileSpec (ICF)	Provides the initial size of the database file.
Size Element for LogFile (ICF)	Is the initial size of the log file.
SqlServerSystem Element (ICF)	Provides the name of an instance of SQL Server that hosts the Notification Services instance database and its application databases.
Value Element for Application/Parameters/Parameter (ICF)	Is the value of a parameter passed to the ADF.
Value Element for DeliveryChannel/Arguments/Argument (ICF)	Is the value of one argument passed to the delivery channel.
Value Element for ParameterDefaults/Parameter (ICF)	Is the value of the parameter.
Version Element (ICF)	Contains elements that provide the Notification Services version number used by the instance.

Reference

Concepts

Other Resources

Help and Information