How to: Create the Metadata File for the Add-In

2016-10-19

Applies To: Windows Server 2012 Essentials, Windows Home Server 2011, Windows Storage Server 2008 R2 Essentials, Windows Small Business Server 2011 Essentials

After you create the Windows Installer packages for your add-in, you create the metadata file for the add-in. You use the procedures listed in the following sections to create the Windows Installer packages:

The metadata provides information about the add-in that is used by the add-in deployment infrastructure. If the information in this file is not correct, the add-in will not be installed. For more information about the elements that are used for the add-in metadata, see Metadata XML Schema Reference.

To create the metadata file for the add-in

Open your add-in project, right-click your project, click Add, and then click New Item.
In the Templates pane, click XML File, type AddIn.xml in the Name box, and then click OK.

Note

You must name the metadata file AddIn.xml or the cab file will not be successfully installed.

Add the metadata elements to define your add-in. The following code example shows a sample of an AddIn.xml file:

<?xml version="1.0" encoding="utf-8"?>  
<Package xmlns="https://schemas.microsoft.com/WindowsServerSolutions/2010/03/Addins" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  
   <Id>969033D5-6895-4EA8-AF0F-623D337BD606</Id>  
   <Version>1.0.0.0</Version>  
   <Name>Sample Add-in</Name>  
   <Allow32BitOn64BitClients>false</Allow32BitOn64BitClients>  
   <ServerBinary>  
      <File>  
         <ProductCode>27848FEA-00E0-454E-A48E-419B1555FD20</ProductCode>  
         <Version>1.0</Version>  
         <Name>SampleWSSServerDeployment.msi</Name>  
         <Filter>  
            <Language>en-US</Language>  
            <IsLanguageFallback>true</IsLanguageFallback>  
         </Filter>  
      </File>  
   </ServerBinary>  
   <ClientBinary32>  
      <File>  
         <ProductCode>856EBFA3-6503-4158-9A96-E0BA3D4F35E7</ProductCode>  
         <Version>1.0.0.0</Version>  
         <Name>SampleWSSClientDeployment32.msi</Name>  
         <Filter>  
            <MinOSVersion>6.0</MinOSVersion>  
            <OSEdition>MediaCenter</OSEdition>  
            <Language>en-US</Language>  
            <IsLanguageFallback>true</IsLanguageFallback>  
         </Filter>  
      </File>  
   </ClientBinary32>  
   <ClientBinary64>  
      <File>  
         <ProductCode>856EBFA3-6503-4158-9A96-E0BA3D4F35E8</ProductCode>  
         <Version>1.0.0.0</Version>  
         <Name>SampleWSSClientDeployment64.msi</Name>  
         <Filter>  
            <MinOSVersion>6.0</MinOSVersion>  
            <OSEdition>MediaCenter</OSEdition>  
            <Language>en-US</Language>  
            <IsLanguageFallback>true</IsLanguageFallback>  
         </Filter>  
      </File>  
   </ClientBinary64>  
   <SupportUrl>http://example.com/support.html</SupportUrl>  
   <PrivacyStatement>http://privacystatement</PrivacyStatement>  
</Package>

Save the file.

Share via

How to: Create the Metadata File for the Add-In

To create the metadata file for the add-in

Additional resources