How to: Create a Configuration XML File

 

Applies To: Windows Server 2012 Essentials

The XML configuration file for a hosted email adapter describes the general configuration elements, such as the name and URL of the hosted email service. The operating system uses the information in the file to configure the framework. In addition, you can use much of the optional information, such as the logo and contact information, into the UI elsewhere in the solution. Once you have created the configuration file, you may choose to localize the file, and then ensure that the files are installed in the appropriate location during distribution.

The following table describes the elements of the configuration XML file. For more information, see the Hosted Email XML Schema Reference.

Element	Required?	Description
Addin	Required	General description of the add-in
Service	Required	General description of the service
ShortName	Required	Short name of the hosted email service.
FullName	Optional	Full name of the hosted email service.
Provider	Required	General description of the provider.
Name	Required	Name of the service provider.
Website	Required	Website of the service provider.
Address	Optional	Address of the service provider.
ServiceSignupURL	Optional	Sign up URL for the hosted email service.
ServiceSigninPortal	Optional	Admin portal for the hosted email service.
RetrievePasswordURL	Optional	URL for the admin to retrieve the admin password.
ServiceDescription	Required	Description of the hosted email service.
LogoImage	Optional	Hosted email service logo.
SupportContact	Optional	General description of the support contact.
Phone	Optional	Support phone number.
Email	Optional	Support email.
HideBuiltinUI	Optional	Built-in UI’s that have been disabled; used only if you do not want to use one or more built-in UIs.
PasswordSync	Optional	Indicates if password sync is supported.
PasswordPolicyOnServer	Optional	General description of the password policy for the hosted email service.

To create an XML Configuration File

1. Create an XML file using the XML elements described above.

   You are required to give the basic information for the add-in, a simple name of the service, the name and website of the host provider, as well as a description of the service. You may also supply a number of other pieces of information, such as support information, what elements of the UI you have chosen to modify or replace, and whether your service syncs passwords with the local server. For more information, see the Hosted Email XML Schema Reference.

   As part of the required pieces of information you supply to describe the add-in, you must supply a GUID that identifies your add-in. There are a number of tools you can use to create a GUID, such as the tool. Once you do so, you can use the GUID to associate your adapter with other features of your add-in. For more information, see Addin Element and How to: Extend an Existing Dialog or Wizard.

2. Once you have created the configuration file, you may choose to localize the file.

   If there is a configuration file under the specific culture directory of the current UI culture, the specific one will be loaded. For example, the configuration file under the “de-DE” directory will be loaded on a German version of Windows Server Essentials. Otherwise, the neutral configuration file stored in %ProgramFiles%\Windows Server\Bin\AddIns\HostedEmail\*.addin will be loaded.

3. Once you have created the configuration file, the add-in, and any changes to the UI, you can deploy the entire package. For more information, see How to: Deploy the Add-In.

Example

The following XML describes a simple configuration file for a Hosted Email framework adapter. For the complete sample, see Quickstart: Creating a Hosted Email Adapter.

<?xml version="1.0" encoding="utf-8" ?>
<addin id="1F8D7206-D1F1-476C-A1DE-D1560634F8FB" name="Hosted Email Add-in" basedir="c:\program files\Windows Server\Bin" type="Microsoft.WindowsServerSolutions.HostedEmailIntegration, CustomAddin" >
  <Service>
    <ShortName>Contoso Services</ShortName>
    <FullName>Contoso Services</FullName>
    <Name>Contoso Computer</Name>
    <Provider>
      <Address>One Microsoft Way, Redmond, WA 98052</Address>
      <Website>https://www.contoso.com</Website>
    </Provider>
    <ServiceSignupURL>https://contoso.com/signup</ServiceSignupURL>
    <ServiceUserPortal>https://contoso.com/portal</ServiceUserPortal>
<ServicesDescription>Contoso Services deliver productivity and collaboration tools as a subscription service. With Contoso Services your organization can provide network users with a full set of cost efficient productivity tools that are compliant and secure.
</ServicesDescription>
    <LogoImage>Contoso\Logo.PNG</LogoImage>
    <SupportContact>
      <Phone>400-888-8888</Phone>
      <Email>support@contoso.com</Email>
    </SupportContact>
  </Service>
  <!--
  <HideBuiltinUI>
    <UIAddin>HEAddUser</UIAddin>
    <UIAddin>HERemoveUser</UIAddin>
    <UIAddin>HEUserProperty</UIAddin>
    <UIAddin>HEEnableUser</UIAddin>
    <UIAddin>HEDisableUser</UIAddin>
    <UIAddin>HEResetPassword</UIAddin>
    <UIAddin>HEUserTab</UIAddin>
</HideBuiltinUI>
-->
  <PasswordSync>
    <PasswordPolicyOnServer level="Medium" minlength="8"></PasswordPolicyOnServer>
  </PasswordSync>
</addin>