Sync Configuration Service Provider

Use the Sync Configuration Service Provider to configure synchronization settings on the device.

Note Access to this Configuration Service Provider is determined by Security roles. Because OEMs and Mobile Operators can selectively disallow access, ask them about the availability of this Configuration Service Provider. For more information, see Security Roles.

The following table shows the default settings.

Characteristics

Calendar

Calendar synchronization settings.

CarrierConnectorList

A list of available mobile operators. The lists of mobile operators vary from one server to another. The listed name for the same mobile operators can differ based on the preference of the administrator creating the mobile operators objects. The mobile operator list must to be retrieved from the server during a synchronization. After a completed synchronization the mobile operators connector name menu is populated with the Carrier Friendly Names retrieved from the administrator.

Connection

The name, location, and connection information for the synchronization operation.

Contacts

Contacts synchronization settings.

FolderHierarchy

The beginning of the folder hierarchy section.

Note  The folder hierarchy settings need to be sent to the device after the initial sync has already been performed, otherwise the folder hierarchy is not yet on the device and the provisioning XML will not do anything.

Mail

Mail synchronization settings.

PeakDays

This characteristic is used by the Settings characteristic to set the peak days of service.

Settings

Sets scheduled synchronization times and item conflict resolution settings.

Parms

AllowSSLOption

This parm is used in the Connection characteristic to allow the user to have the option of selecting a non-SSL server address when connecting to an ActiveSync server. Enabling AllowSSLOption allows the user the choice of using SSL on the device and on the desktop computer.

AllowSSLOption sets a registry key that disables the user interface (UI) option and forces the use of SSL. Only the administrator should modify this setting

The following table shows the default settings.

Permissions	Read/write
Data type	Boolean
Roles allowed to query and update setting	Operator Operator TPS Manager AuthenticatedUser

AutoSyncWhenCradled

This parm is used in the Settings characteristic to enable autosync capability when cradled. The phone also needs to establish a partnership with the desktop computer. If ActiveSync 3.7 is not installed on the desktop computer, or if it is installed but the user chose to not create a partnership when the phone is cradled, automated synchronization will not start. The following table lists the possible values.

Value	Description
0	Do not autosync
1	Sync at the interval given by SyncAfterTimeWhenCradled

The following table shows the default settings.

Permissions	Read/write
Data type	Boolean
Label	When connected to my PC, synchronize with the server every:
Roles allowed to query and update setting	Manager AuthenticatedUser

BodyTruncation

This parm is used in the Settings characteristic to identify the maximum body size for the notes fields in contacts and the calendar. The following table lists the possible values.

Value	Description
512	.5k
1024	1K
5120	5K
-1	All
0	Header Only

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Roles allowed to query and update setting	Manager AuthenticatedUser

This parm is used in the Sync Configuration Service Provider under Settings\.

CalendarAgeFilter

This parm is used in the Calendar characteristic as an age filter for the calendar. The filter only filters out expired calendar entries; all future appointments are synced to the device. This parm also determines how long expired calendar entries can remain on the device. The following table lists the possible values.

Value	Description
0	All
4	2 Weeks
5	1 Month
6	3 Months
7	6 Months

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Include past
Roles allowed to query and update setting	Manager AuthenticatedUser

CarrierConnector

This parm is used in the Settings characteristic to set the delivery path for Short Message Service (SMS) notifications for synchronizations. This parm is a string from the CarrierConnectorlist characteristic containing the mobile operator connector name from the Carrier Friendly Names retrieved from the Active Directory. This parm allows administrators to control the outbound path of notifications to the mobile operator for devices that support notification-based synchronizations. The CarrierConnector provides a way to map a device to a mobile operator for administrators that have contracts with a specific mobile operator and want to manage each device's delivery path for all notifications.

The following table shows the default settings.

Permissions	Read/write
Data type	String
Label	Mobile Operator Address
Roles allowed to query and update setting	Manager AuthenticatedUser

ClientProtocolVersion

This read-only parm is used in the Settings characteristic to specify the protocol version number of the protocol to use for synchronization. Server sync requires that the client and server use the same protocol version to work. A client must specify to the server what protocol version to use for synchronization.

ConflictResolution

This parm is used in the Settings characteristic to determine how to resolve conflicts. The following table lists the possible values.

Value	Description
1	Replace on device
2	Replace on server

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Conflict resolution
Roles allowed to query and update setting	Manager AuthenticatedUser

Device

This is a read-only parm containing a string that identifies the type of device. For Pocket PC devices, this parm contains the string "Pocket PC"; for Smartphone devices, this parm contains the string "Smartphone".

The following table shows the default settings.

Permissions	Read-only
Data type	String
Roles allowed to query and update setting	Operator Operator-TPS Manager AuthenticatedUser

This parm is used in the Sync Configuration Service Provider under Connection\.

DeviceAddressingMethod

This parm is used in the Settings characteristic to specify how to address your device to synchronize new items as they arrive on devices that support notification based synchronization. The following table lists the possible values.

Value	Description
1	Device SMS address, SMTP.
2	Corporate Service Provider, using the phone number for the device address.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Device Address
Roles allowed to query and update setting	Manager AuthenticatedUser

DeviceID

This read-only parm is used in all Sync characteristics as a unique identifier for the device. The device automatically generates the value of this parm.

The following table shows the default settings.

Permissions	Read-only
Data type	String
Label	Device ID
Roles allowed to query and update setting	Manager AuthenticatedUser

This parm is used in the Sync Configuration Service Provider under Connection\.

DevicePhoneNumber

This parm is used in the Settings characteristic to set the device's phone number.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Device Phone Number
Roles allowed to query and update setting	Manager AuthenticatedUser

DevicePhoneReadOnly

This parm is used in the Settings characteristic to set the Device Phone Number to read-only. It is an integer value that is set to 1 when the Device Phone Number is loaded by default on the device. The following table lists the possible values.

Value	Description
0	The Device Phone Number may be edited.
1	The Device Phone Number cannot be changed in the edit box. It is read-only.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Roles allowed to query and update setting	Manager AuthenticatedUser

DeviceSMSAddress

This parm is used in the Settings characteristic to provide a string with a valid SMS address for the device. It is used to synchronize new items as they arrive, for example: 8885551212@example.com. The SMS address is hidden for non-radio devices.

The following table shows the default settings.

Permissions	Read/write
Data type	String
Label	Device SMS Address
Roles allowed to query and update setting	Manager AuthenticatedUser

DisconnectWhenDone

This parm is used in the Settings characteristic to identify whether or not to disconnect when Desktop ActiveSync is finished if the sync was done remotely.

The following table shows the default settings.

Permissions	Read/write
Data type	Boolean
Roles allowed to query and update setting	Manager AuthenticatedUser

Domain

This parm is used in the Connection characteristic to identify the network domain for the Server ActiveSync server.

Send the Domain value with the settings update only when necessary, for example, when the domain has changed. The string compare logic in the Sync Configuration Service Provider is case sensitive. If the new domain value does not equal the current domain value, the Sync Configuration Service Provider logic treats the transaction as a new domain. For more information about the logic behind what happens to Messaging and PIM data when a username and/or domain change, see the description of the SyncSwitchPurge flag.

The following table shows the default settings.

Permissions	Read/write
Data type	String
Label	Domain
Roles allowed to query and update setting	Manager AuthenticatedUser

EmailAgeFilter

This parm is used in the Mail characteristic as an age filter for e-mail. The filter only filters out expired items; all unexpired e-mail messages are synced to the device. This parm also determines how long expired e-mail messages can remain on the device. The following table lists the possible values.

Value	Description
1	1 Day
2	3 Days
3	1 Week
4	2 Weeks
5	1 Month
0	All

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Include past
Roles allowed to query and update setting	Manager AuthenticatedUser

Enabled

This parm is used in the Mail characteristic to identify whether or not mail is synchronized using Server ActiveSync.

The following table shows the default settings.

Permissions	Read/write
Data type	Boolean
Label	Synchronize Inbox
Roles allowed to query and update setting	Manager AuthenticatedUser

Enabled

This parm is used in the Calendar characteristic to enable the calendar application for Server ActiveSync.

The following table shows the default settings.

Permissions	Read/write
Data type	Boolean
Label	Synchronize Calendar
Roles allowed to query and update setting	Manager AuthenticatedUser

Enabled

This parm is used in the Contacts characteristic to enable the contacts (address book) application to use Server ActiveSync.

The following table shows the default settings.

Permissions	Read/write
Data type	Boolean
Label	Synchronize Contacts
Roles allowed to query and update setting	Manager AuthenticatedUser

FolderType

This parm is used in the FolderHierarchy characteristic to identify an e-mail folder type and cannot be changed. The following table lists the possible values.

Value	Description
0	Invalid folder
1	User created folder (root)
2	Inbox folder
3	Drafts folder
4	Deleted Items folder
5	Sent Items folder
6	Outbox folder
7	Tasks folder
8	Calendar folder
9	Contacts folder
10	Notes folder
11	Journal folder
12	User created Mail folder
13	User created Calendar folder
14	User created Contacts folder
15	User created Tasks folder
16	User created Journal folder
17	User created Notes folder
18	Invalid folder

The following table shows the default settings.

Permissions	Read-only
Data type	Integer
Roles allowed to query and update setting	Manager AuthenticatedUser

MailBodyTruncation

This parm is used in the Mail characteristic to identify the amount of e-mail message body to fetch during a Server ActiveSync. The following table lists the possible values.

Value	Description
512	.5k
1024	1K
5120	5K
-1	All
0	Header Only

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Limit e-mail size to
Roles allowed to query and update setting	Manager AuthenticatedUser

MailFileAttachments

This parm is used in the Mail characteristic to specify the maximum size (in bytes) an attachment can be to automatically download. For instance if this parm is set to 2048, any message with an attachment smaller than 2k in size would have that attachment automatically downloaded during sync.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Roles allowed to query and update setting	Manager AuthenticatedUser

NotificationsSupported

This parameter specifies whether SMS notifications are supported. The notifications option is hidden for non-radio devices. For non-radio devices the only available scheduled synchronizations are at the peak and non-peak hours frequencies. The following table lists the possible values.

Value	Description
0	Not supported. No SMS notifications can be used to schedule synchronizations.
1	Supported. SMS notifications can be used to schedule synchronizations.

OffPeakFrequency

This parm determines how frequently scheduled synchronization will be performed during off-peak hours. Switching from peak to off-peak is based on the device's clock. The following table lists the possible values.

Value	Description
0	Off, no scheduled synchronization during peak hours.
5	5 minutes between synchronizations during peak times.
10	10 minutes between synchronizations during peak times.
15	15 minutes between synchronizations during peak times.
30	30 minutes between synchronizations during peak times.
60	60 minutes between synchronizations during peak times.
120	120 minutes between synchronizations during peak times.
240	240 minutes between synchronizations during peak times.
>-1	Synchronize as new items arrive. This will not appear unless the device has synchronized with a server that supports notifications.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	During off-peak times, Sync
Roles allowed to query and update setting	Manager AuthenticatedUser

OutboundMailDelay

This parm is used in the Settings characteristic to set the time delay for sending mail. The latency used for synchronizing after an outgoing item is sent is a value read from the registry. The default latency for Pocket PC devices is 0 minutes; the default latency for Smartphone devices is 5 minutes.

When synchronizing on a mobile schedule or by using notifications, there is the possibility that a significant amount of time can lapse between synchronizations. To keep data always-up-to date outbound as well as inbound between synchronizations based mobile schedules or the next notification, this parameter allows you to schedule an additional synchronization to push outbound items.

Since real-time response works by registering a schedule synchronization, which is considered a background synchronization, no UI interrupts the user.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Roles allowed to query and update setting	Manager AuthenticatedUser

Password

This parm is used in the Connection characteristic to identify the Server ActiveSync password. The password is a write-only field. A string consisting of 16 asterisks will be returned if this field is queried. If this same string is returned it is treated as a "no-op" and the password field is not changed.

The first time the phone is provisioned send an empty string value for the user password. On subsequent configurations, do not set the password by making sure there is no password parm in the XML file. If the over-the-air (OTA) server cannot recognize the first provision, always send empty string values for the password.

If the first provisioning file does not contain an empty string value for the password, the user will encounter the 0x8007667 error. If this error occurs, the user must enter the password in Settings.

The following table shows the default settings

Permissions	Write-only
Data type	String
Label	Password:
Semantic type	alphanumeric-password
Roles allowed to query and update setting	Operator Operator-TPS Manager

PeakEndTime

This parm is used in the Settings characteristic as a time control that allows setting any valid hour and minute combination in 24-hour format. The control sets the end of the peak service period for Peak Days.

The following table shows the default settings.

Permissions	Read/write
Data type	Time
Label	Peak End Time
Roles allowed to query and update setting	Manager AuthenticatedUser

PeakStartTime

This parm is used in the Settings characteristic as a time control that allows setting any valid hour and minute combination in 24-hour format. The control sets the beginning Peak service period for Peak Days.

The following table shows the default settings.

Permissions	Read/write
Data type	Time
Label	Peak Start Time
Roles allowed to query and update setting	Manager AuthenticatedUser

PeakFrequency

This parm is used in the Settings characteristic to determine how frequently scheduled synchronization will be performed during peak hours. Switching from peak to off-peak is based on the device's clock. The following table lists the possible values.

Value	Description
0	Off, no scheduled synchronization during peak hours.
5	5 minutes between synchronizations during peak times.
10	10 minutes between synchronizations during peak times.
15	15 minutes between synchronizations during peak times.
30	30 minutes between synchronizations during peak times.
60	60 minutes between synchronizations during peak times.
120	120 minutes between synchronizations during peak times.
240	240 minutes between synchronizations during peak times.
>-1	Synchronize as new items arrive. This will not appear unless the device has synchronized with a server that supports notifications.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	During peak times, Sync
Roles allowed to query and update setting	Manager AuthenticatedUser

RadioEnabledDevice

This parm is used in the Settings characteristic to determine if the device is radio enabled. The following table lists the possible values.

Value	Description
0	No radio on device.
1	Radio on device.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Radio
Roles allowed to query and update setting	Manager AuthenticatedUser

SendMailItemsImmediately

This parm is used in the Settings characteristic to enable sending mail with no delay. Use SendMailItemsImmediately in conjunction with OutboundMailDelay. The following table lists the possible values for SendMailItemsImmediately.

Value	Description
0	Disabled.
1	Enabled. Send mail after the delay specified by the OutboundMailDelay parm.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Sync outgoing items as they are sent
Roles allowed to query and update setting	Manager AuthenticatedUser

Sun

This parm is used in the Settings\PeakDays characteristic to specify whether Sunday is a peak service day, one of the days when the most e-mail is received. The following table lists the possible values.

Value	Description
0	Disabled, not a peak day.
1	Enabled, is a peak day.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Peak Days
Roles allowed to query and update setting	Manager AuthenticatedUser

Mon

This parm is used in the Settings\PeakDays characteristic to specify whether Monday is a peak service day, one of the days when the most e-mail is received. The following table lists the possible values.

Value	Description
0	Disabled, not a peak day.
1	Enabled, is a peak day.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Peak Days
Roles allowed to query and update setting	Manager AuthenticatedUser

Tue

This parm is used in the Settings\PeakDays characteristic to specify whether Tuesday is a peak service day, one of the days when the most e-mail is received. The following table lists the possible values.

Value	Description
0	Disabled, not a peak day.
1	Enabled, is a peak day.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Peak Days
Roles allowed to query and update setting	Manager AuthenticatedUser

Wed

This parm is used in the Settings\PeakDays characteristic to specify whether Wednesday is a peak service day, one of the days when the most e-mail is received. The following table lists the possible values.

Value	Description
0	Disabled, not a peak day.
1	Enabled, is a peak day.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Peak Days
Roles allowed to query and update setting	Manager AuthenticatedUser

Thr

This parm is used in the Settings\PeakDays characteristic to specify whether Thursday is a peak service day, one of the days when the most e-mail is received. The following table lists the possible values.

Value	Description
0	Disabled, not a peak day.
1	Enabled, is a peak day.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Peak Days
Roles allowed to query and update setting	Manager AuthenticatedUser

Fri

This parm is used in the Settings\PeakDays characteristic to specify whether Friday is a peak service day, one of the days when the most e-mail is received. The following table lists the possible values.

Value	Description
0	Disabled, not a peak day.
1	Enabled, is a peak day.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Peak Days
Roles allowed to query and update setting	Manager AuthenticatedUser

Sat

This parm is used in the Settings\PeakDays characteristic to specify whether Saturday is a peak service day, one of the days when the most e-mail is received. The following table lists the possible values.

Value	Description
0	Disabled, not a peak day.
1	Enabled, is a peak day.

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	Peak Days
Roles allowed to query and update setting	Manager AuthenticatedUser

SavePassword

This parm is used by the Connection characteristic to identify whether or not to save the user's password after a sync operation.

The following table shows the default settings.

Permissions	Read/write
Data type	Boolean
Label	Save password
Roles allowed to query and update setting	Operator Operator-TPS Manager AuthenticatedUser

SaveSentItems

This read-only parm is used in the Mail characteristic to identify whether or not sent items are saved in the Sent Items folder on the server.

The following table shows the default settings.

Permissions	Read-only
Data type	Boolean
Roles allowed to query and update setting	Operator Operator-TPS Manager

Server

This parm is used in the Connection characteristic to identify the name of the Server ActiveSync server.

The following table shows the default settings.

Permissions	Read/write
Data type	String
Label	Server name
Roles allowed to query and update setting	Manager AuthenticatedUser

SyncAfterTimeWhenCradled

This parm is used in the Settings characteristic to track the amount of time (in minutes) between device-initiated connections to the sync server when cradled. ActiveSync 3.6 or later must be installed on the desktop computer for automated synchronization using this parm. A manual sync restarts this timer. The following table lists the possible values.

Value	Description
0	Manually synchronize
5	5 minutes. Default value.
15	15 minutes
30	30 minutes
60	60 minutes
120	2 hours
240	4 hours

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Roles allowed to query and update setting	Manager AuthenticatedUser

SyncEnabled

This parm is used in the FolderHierarchy characteristic to identify whether or not sync is enabled for a specific folder. Not all folders can have sync enabled; for example, Drafts and Outbox cannot have sync enabled. The following table lists the possible values.

Value	Description
0	Sync disabled
1	Sync enabled

The following table shows the default settings.

Permissions	Read/write
Data type	Boolean
Label	Enable sync
Roles allowed to query and update setting	Manager AuthenticatedUser

SyncSwitchPurge

This parm is used in the following characteristics:

• Calendar characteristic to identify whether or not to keep the existing calendar data on the device when switching from Desktop ActiveSync to Server ActiveSync, or when changing the server or UserID information. The recommended value for this parm is 3.
• Contacts characteristic to identify whether or not to keep the existing contact data on the device when switching from Desktop ActiveSync to Server ActiveSync, or when changing server or UserID information. The recommended value for this parm is 3. The following table lists the possible values.
• Mail characteristic to identify whether or not to keep the existing mail data on the device when switching from Desktop ActiveSync to Server ActiveSync, or when changing server or UserID information. The recommended value of this parm is 3. The following table lists the possible values.

The following table shows the possible values.

Value	Description
0	Keep if changed
1	Purge always
2	Keep always
3	Purge if changed

Note  The device does not store a value for the SyncSwitchPurge parm. The parm is intended to be used more as a command than as a stored setting. A query for the parm value will always return a value of 0.

The following table shows the default settings for this parm in the Sync Configuration Service Provider.

Permissions	Read/Write
Data type	Integer
Roles allowed to query and update setting	Manager AuthenticatedUser

SyncWhenRoaming

Option to allow synchronization when roaming. The following table lists the possible values.

Value	Description
0	Manually synchronize
1	Use mobile settings

The following table shows the default settings.

Permissions	Read/write
Data type	Integer
Label	When roaming, sync
Roles allowed to query and update setting	Manager AuthenticatedUser

UseSSL

This parm is used in the Connection characteristic to provide the user the option to choose whether or not to use Secure Sockets Layer (SSL) when connecting to the server.

Users access this feature in the same location as the edit box to configure the server address.

On Pocket PC devices, this is in the ActiveSync application, Options dialog, Server tab. On Smartphone devices, this is in the ActiveSync application, Options list, Connection page.

Users, when entering the address of the Web server, select the checkbox titled "This server is secure (SSL)" to specify whether or not that server requires SSL. The default is that the server requires SSL. The ActiveSync application on the device will examine the state of this checkbox at the beginning of every synchronization session, and construct a server Web address to be used for all sync http requests. If the checkbox indicates that SSL is required, the application will prepend "https://" to the beginning of the server address (the server address is a URL without a prefix, for example "www.publicaccessnexus.net" or "intranetnexus").

If SSL is NOT required, the device prepends "http://" to the Web address. The following table lists the possible values.

Value	Description
0	Using Secure Sockets Layer (SSL) when connecting is not required.
1	Using Secure Sockets Layer (SSL) when connecting is required.

The following table shows the default settings.

Permissions	Read/write
Data type	Boolean
Label	Server is secure (SSL)
Roles allowed to query and update setting	Operator Operator TPS Manager AuthenticatedUser

URI

This parm is used in the Connection characteristic to identify the URI used for connecting to ActiveSync (server). The URI must match the IIS setup. Only the administrator should modify this setting.

User

This parm is used in the Connection characteristic to identify the Server ActiveSync Username.

Send the username value with the settings update only when necessary, for example when the username has changed. The string compare logic in the Sync Configuration Service Provider is case sensitive. If the new username value does not equal the current username value, the Sync Configuration Service Provider logic treats the transaction as a new username. See the description of the SyncSwitchPurge flag for more information about the logic behind what happens to Messaging and PIM data when a username and/or domain change.

The following table shows the default settings.

Permissions	Read/write
Data type	String
Label	Username
Roles allowed to query and update setting	Manager AuthenticatedUser

The following table shows the default settings.

Permissions	Read/write
Data type	String
Roles allowed to query and update setting	Operator Operator-TPS Manager AuthenticatedUser

VersionMajor

This read-only parm is used in the Settings characteristic to identify the major version number for the Sync Configuration Service Provider. If the value is less than 1, Server ActiveSync is not supported on the device

VersionMinor

This read-only parm is used in the Settings characteristic to identify the minor version number for the Sync Configuration Service Provider.

Elements

For information about specific elements, see MSPROV DTD Elements.

See Also

Configuration Service Provider Reference for Windows Mobile Devices | Sync Configuration Service Provider Examples

Send feedback on this topic to the authors.

© 2005 Microsoft Corporation. All rights reserved.