Minimal ICF Template

This sample instance configuration file (ICF) shows the sections and elements that must be included in an ICF for the file to be valid. This ICF does not use the following sections:

  • ParameterDefaults: If your ICF does not use parameters, such as %SystemName%, the ParameterDefaults section is not relevant.
  • Version: The default version is 0.0.0.0.
  • History: The history information is for your use, and is not used by Notification Services.
  • Database: Because this ICF does not specify the database name, schema name, and database properties, Notification Services creates a database named instanceNameNSMain, creates all instance objects in the dbo schema, and uses the model database as a template for database properties.
  • EncryptArguments: Notification Services does not encrypt instance delivery channel and application event provider argument values.

Important

If you do not define a value for an element, omit the element from the ICF. Many elements cannot be empty.

Template

Click Copy Code to copy this template to the Clipboard.

<?xml version="1.0" encoding="utf-8"?>
<NotificationServicesInstance 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="https://www.microsoft.com/MicrosoftNotificationServices/ConfigurationFileSchema">

<!-- Notification Services Instance Name -->
<InstanceName></InstanceName>

<!-- Database Engine Instance -->
<SqlServerSystem></SqlServerSystem>

<!-- Applications -->
<Applications>
    <Application>
        <ApplicationName></ApplicationName>
        <BaseDirectoryPath></BaseDirectoryPath>
        <ApplicationDefinitionFilePath></ApplicationDefinitionFilePath>
    </Application>
</Applications>

<!-- Delivery Channels -->
<DeliveryChannels>
    <DeliveryChannel>
        <DeliveryChannelName></DeliveryChannelName>
        <ProtocolName></ProtocolName>
    </DeliveryChannel>
</DeliveryChannels>

</NotificationServicesInstance>

Example

The following example shows how to use this minimal template to define an instance of Notification Services. This instance is named MyInstance and its databases are (or will be) created on database server MySQLServer. The instance hosts one application, MyApplication, and has one delivery protocol, EmailChannel.

This minimal delivery channel configuration does not specify any e-mail server arguments, such as a server name. Instead, it is using the local Internet Information Services (IIS) SMTP service that is configured to relay messages using smart host. For more information, see DeliveryChannel Element (ICF).

<?xml version="1.0" encoding="utf-8"?>
<NotificationServicesInstance 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="https://www.microsoft.com/MicrosoftNotificationServices/ConfigurationFileSchema">

<!-- Unique NS instance name. -->
<InstanceName>MyIntstance</InstanceName>

<!-- Databases located on MySQLServer. -->
<SqlServerSystem>MySQLServer</SqlServerSystem>

<!-- Applications on MyInstance. -->
<Applications>
    <Application>
        <ApplicationName>MyApp</ApplicationName>
        <BaseDirectoryPath>C:\NS\MyInstances</BaseDirectoryPath>
        <ApplicationDefinitionFilePath>C:\NS\MyInstances\MyApp
        </ApplicationDefinitionFilePath>
    </Application>
</Applications>

<!-- Delivery channels used by MyInstance.-->
<DeliveryChannels>
    <DeliveryChannel>
        <!-- My delivery channel name.-->
        <DeliveryChannelName>EmailChannel</DeliveryChannelName>
        <!-- Delivery channel uses built-in SMTP protocol.-->
        <ProtocolName>SMTP</ProtocolName>
    </DeliveryChannel>
</DeliveryChannels>
</NotificationServicesInstance>

See Also

Concepts

Instance Configuration File Reference
Instance Configuration File Templates

Other Resources

Configuring Instances of Notification Services

Help and Information

Getting SQL Server 2005 Assistance

Change History

Release History

17 July 2006

Changed content:
  • Added example that uses the minimal template.