Creating an IP Phone Provisioning File

The Windows CE .NET 4.2 Telephony User Interface (TUI) uses a provisioning file to provide information to the IVoIPDirectoryClient interface. The IVoIPDirectoryClient uses the information in the provisioning file to register a phone to a SIP server. The VoIP Application Interface Layer (VAIL) comes with three implementations of the IVoIPDirectoryClient; file-based, LDAP, and manual. For more information, see IP Phone Provisioning.

All three of the directory clients use the same XML schema. The following example shows the format of the content:

<parameter>someone@example.com</parameter>

To register the phone to the SIP server, the TUI uses a file called Provisioning.xml. However, if you do not have a SIP server, you can still create an IP phone by using a fake URI and a fake SIP server name in the Provisioning.xml file.

The following example shows the minimum information required in the file to provision the phone:

<sip_uri>someone@example.com</sip_uri>

<sip_server>SIP Server Address</sip_server>

Depending on your SIP server setup, you may need to provide additional information, such as data transport type, authentication scheme, and username. The following example shows the schema for providing the other types of information:

<sip_uri>someone@example.com</sip_uri>

<sip_server>SIP Server Address</sip_server>

<sip_transport_type>TCP</sip_transport_type>

<sip_auth>Kerberos</sip_auth>

<sip_username>Username</sip_username>

You only need to include the username if the SIP server requires authentication. Because the TUI does not provide an adequate means to enter a strong password, you can provide the password to the server using the following schema:

<sip_password>Password</sip_password>

The following table shows the options supported by the installed directory clients and the default value that the TUI uses if the provisioning file does not specify the option.

The following table shows the authentication scheme supported based on the transport type.

To create a provisioning file

1. From the File menu, choose New Project or File.

2. Choose the Files tab, and then choose Text file.

3. In the File name dialog box, type Provisioning.xml.

   The Telephony UI searches for a file with the name Provisioning.xml in the \Windows directory of the device and in the release directory. You can change the file name in the registry if you want to use another name. The following code shows the registry entry:

   [HKEY_LOCAL_MACHINE\Software\Microsoft\VoIPUI\Provisioning]
     "File"="<File Name>"
   

4. In the Location dialog box, select the browse button.

5. Navigate to %_WINCEROOT\public\<Platform Name>\RelDir\_X86Release folder, and then choose OK.

6. To close the New Project or File window, choose OK.

7. Type the XML schema.

   The following example shows the minimum information required to provision the phone if the SIP server does not require authentication.

   <parameters>

   <sip_uri>someone@example.com</sip_uri>

   <sip_server>SIP Server Address</sip_server>

   </parameters>

   If you do not have a SIP server, use a fake URI and a fake SIP server address. Ensure that the SIP server address is non-existent. The following example shows the information required.

   <parameters>

   <sip_uri>Fake URI</sip_uri>

   <sip_server>Fake SIP Server Address</sip_server>

   </parameters>

8. Save and close the file.

You are now ready to configure the remote download connection. If you are creating an IP phone on a CEPC, see Configuring an Ethernet Remote Connection. If you are creating an IP phone on an Emulator, see Downloading the Emulator IP Phone Image.

See Also

How to Create an IP Phone on a CEPC | How to Create an IP Phone on an Emulator | IP Phone Provisioning | VoIP Application Interface Layer Architecture | VoIP Application Interface Layer Reference | Real-time Communications Architecture

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.