Sync Configuration Service Provider

Windows Mobile 6.5
4/8/2010

Use the Sync Configuration Service Provider to configure synchronization settings on the device. You can synchronize with a server and two separate desktops.

The Sync Configuration Service Provider is supported for synchronizing with a single source. For information about synchronizing with multiple sources, see Sync Configuration Service Provider Examples for OMA DM.

This Configuration Service Provider can be managed over both the OMA Client Provisioning (formerly WAP Client Provisioning) and the OMA DM protocol.

Bb737700.note(en-us,MSDN.10).gifNote:
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 about roles, see Security Roles and Default Roles for Configuration Service Providers.

The following table shows the default settings for the root node of this Configuration Service Provider. The default security role maps to each subnode unless specific permission is granted to the subnode.

Permissions

Read/write

Roles allowed to query and update setting

Manager

AuthenticatedUser

The following image shows the management object used by OMA DM.

Bb737700.ee6c8a43-e330-4fb3-8fe5-3995366852f4(en-us,MSDN.10).gif

When using the Sync Configuration Service Provider over OMA Client Provisioning, the Vendor and MSFT nodes are omitted. Otherwise, the XML is the same as that used by OMA DM. The following image shows the top of the management object used by OMA Client Provisioning.

Bb737700.cf688c43-80ad-4e7b-a457-ef73ae260194(en-us,MSDN.10).gif

Settings

Sets scheduled synchronization times and item conflict resolution settings.

Settings/PeakDays

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

Calendar

Calendar synchronization settings.

Contacts

Contacts synchronization settings.

Mail

Mail synchronization settings.

Connection

Connection settings for the synchronization operation.

Tasks

Task synchronization settings.

Text Messages

Text Messages synchronization settings.

Policies

Policy settings that enforce synchronization settings both by modifying the UI (disabling and fixing values for related controls) and by disallowing changes to the settings from Desktop ActiveSync.

Policies/PeakDays

Characteristic used by policies related to peak days of service.

Settings/AllowSSLOption

This parm is used in the Settings 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

Settings/BodyTruncation

This parameter 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

Settings/CalendarAgeFilter

This parameter is used in the Settings 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 parameter 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

Settings/Device

This parameter is used in the Settings characteristics. This is a read-only parameter containing a string that identifies the type of device. For Windows Mobile Professional Windows Mobile Classic, this parameter contains the string "Pocket PC"; for Windows Mobile Standard, this parameter contains the string "Smartphone".

The following table shows the default settings.

Permissions

Read-only (Settings)

Read/write (Connections)

Data type

String

Roles allowed to query and update setting

Manager

AuthenticatedUser

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

Settings/DeviceID

This parameter is used in the Settings characteristics as a unique identifier for the device. The device automatically generates the value of this parameter.

The following table shows the default settings.

Permissions

Read-only

Data type

String

Label

Device ID

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

Settings/DevicePhoneReadOnly

This parameter 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

Connection/Domain

This parameter 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.

The following table shows the default settings.

Permissions

Read/write

Data type

String

Label

Domain

Settings/EmailAgeFilter

This parameter is used in the Settings 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 parameter 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

Mail/Enabled

This parameter 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

Calendar/Enabled

This parameter 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

Contacts/Enabled

This parameter 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

Tasks/Enabled

This parameter is used in the Tasks characteristic to enable the task application to use Server ActiveSync.

The following table shows the default settings.

Permissions

Read/write

Data type

Boolean

Label

Synchronize Contacts

Text Messages/Enabled

This parameter is used in the Text Messages characteristic to enable the text message application to use Server ActiveSync.

The following table shows the default settings.

Permissions

Read/write

Data type

Boolean

Label

Synchronize Text Messages

Settings/EnableNonLocalCrossPollination

This parameter is used in the Settings characteristic to allow or disallow backend cross pollination. The following list shows the possible values:

  • 0 = Disallow backend cross pollination
  • 1 = Allows backend cross pollination<CR><LF>

The following table shows the default settings.

Permissions

Read/write

Data type

Boolean

Settings/HtmlTruncation

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

Value Description

0

Headers only

512

.5Kb

1024

1Kb

2048

2Kb

5120

5Kb

10240

10Kb

20480

20Kb

102400

100Kb

-2

All text, no pictures

-1

Entire message

The following table shows the default settings.

Permissions

Read/write

Data type

Integer

Label

Limit e-mail size to

Settings/MailBodyTruncation

This parameter is used in the Settings characteristic to identify the amount of plain text 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

Settings/MailFileAttachments

This parameter is used in the Settings characteristic to specify the maximum size (in bytes) an attachment can be to automatically download. For instance if this parameter 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

Settings/MIMETruncation

This parameter is used in the Settings characteristic to identify the amount of email message body to fetch during a Server ActiveSync when using MIME.

The following table shows the default settings.

Permissions

Read/write

Data type

Integer

Settings/OffPeakFrequency

This parameter is used in the Settings characteristic. This parameter 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 off-peak hours.

5

5 minutes between synchronizations during off-peak times.

10

10 minutes between synchronizations during off-peak times.

15

15 minutes between synchronizations during off-peak times.

30

30 minutes between synchronizations during off-peak times.

60

60 minutes between synchronizations during off-peak times.

120

120 minutes between synchronizations during peak times.

240

240 minutes between synchronizations during off-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

Settings/OutboundMailDelay

This parameter 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 is 5 seconds.

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

Settings/PeakEndTime

This parameter 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

Settings/PeakFrequency

This parameter 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

Settings/PeakStartTime

This parameter 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

Settings/RadioEnabledDevice

This parameter 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

Data type

Integer

Label

Radio

Settings/PeakDays/Sun

This parameter 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

Settings/PeakDays/Mon

This parameter 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

Settings/PeakDays/Tue

This parameter 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

Settings/PeakDays/Wed

This parameter 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

Settings/PeakDays/Thr

This parameter 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

Settings/PeakDays/Fri

This parameter 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

Settings/PeakDays/Sat

This parameter 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

Settings/SaveSentItems

This read-only parameter is used in the Settings 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

Settings/SendMailItemsImmediately

This parameter 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 parameter.

The following table shows the default settings

Permissions

Read/write

Data type

Integer

Label

Sync outgoing items as they are sent

Connection/Server

This parameter 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

Settings/SyncAfterTimeWhenCradled

This parameter exists, but the device ignores the value and always syncs at the 5 minute interval.

The following table shows the default settings.

Permissions

Read/write

Data type

Integer

Settings/SyncWhenRoaming

This parameter is used in the Settings characteristic to 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

Connection/User

This parameter 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.

The following table shows the default settings.

Permissions

Read/write

Data type

String

Label

Username

Settings/VersionMajor

This read-only parameter 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

The following table shows the default settings.

Permissions

Read-only

Data type

Integer

Settings/VersionMinor

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

The following table shows the default settings.

Permissions

Read-only

Data type

Integer

Policies/PeakDays/Sun

This parameter enforces the value of Settings/PeakDays characteristic.

Value Description

0

Disabled, not a peak day.

1

Enabled, is a peak day.

Policies/PeakDays/Mon

This parameter enforces the value of Settings/PeakDays characteristic.

Value Description

0

Disabled, not a peak day.

1

Enabled, is a peak day.

Policies/PeakDays/Tue

This parameter enforces the value of Settings/PeakDays characteristic.

Value Description

0

Disabled, not a peak day.

1

Enabled, is a peak day.

Policies/PeakDays/Wed

This parameter enforces the value of Settings\PeakDays characteristic.

Value Description

0

Disabled, not a peak day.

1

Enabled, is a peak day.

Policies/PeakDays/Thr

This parameter enforces the value of Settings/PeakDays characteristic.

Value Description

0

Disabled, not a peak day.

1

Enabled, is a peak day.

Policies/PeakDays/Fri

This parameter enforces the value of Settings\PeakDays characteristic.

Value Description

0

Disabled, not a peak day.

1

Enabled, is a peak day.

Policies/PeakDays/Sat

This parameter enforces the value of Settings/PeakDays characteristic.

Value Description

0

Disabled, not a peak day.

1

Enabled, is a peak day.

Policies/DisableDesktopEmailAndPIMSync

This parameter enables and disables synchronization of Email and PIM data with a desktop partnership.

Data type

Integer

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

0 - Allows synchronization with a desktop partnership.

1 - Disallows synchronization with a desktop partnership.

Policies/MaxCalendarAgeFilter

This parameter sets the maximum value that can be set for the Settings/CalendarAgeFilter property either through the Synchronization Configuration Service Provider or through the device's UI.

Data type

Integer

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

4 - 2 weeks

5 - 1 month

6 - 3 months

7 - 6 months

8 - All

Policies/MaxEmailAgeFilter

This parameter sets the maximum value that can be set for the Settings/EmailAgeFilter property either through the Synchronization Configuration Service Provider or through the device's UI.

Data type

Integer

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

1 - 1 day

2 - 3 days

3 - 1 week

4 - 2 weeks

5 - 1 month

0 - All

Policies/MaxHTMLTruncation

This parameter sets the maximum value that can be set for the Settings/MailBodyTruncation property either through the Synchronization Configuration Service Provider or through the device's UI.

Data type

Integer

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

0 - Headers only

512 - .5Kb

1024 - 1Kb

2048 - 2Kb

5120 - 5Kb

10240 - 10Kb

20480 - 20Kb

51200 - 50Kb

102400 - 100Kb

-2 - All text, no pictures

-1 - Entire message

Policies/MaxMailBodyTruncation

This parameter sets the maximum value that can be set for the Settings/MailBodyTruncation property either through the Synchronization Configuration Service Provider or through the device's UI.

Data type

Integer

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

0 - Headers only

512 - .5Kb

1024 - 1Kb

5120 - 5Kb

-1 - Entire message

Policies/MaxMailFileAttachments

This parameter enables and disables the synchronization of attachments as part of email synchronization. If attachment synchronization is allowed, then this parameter also sets the maximum size of attachments that can be synchronized.

Data type

Integer

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

0 - Attachment synchronization is not allowed.

Any other value - Attachment synchronization is allowed but attachments cannot exceed this value (in Kb).

Policies/MaxOffPeakFrequency

This parameter sets the maximum value that can be set for the Settings/OffPeakFrequency property either through the Synchronization Configuration Service Provider or through the device's UI.

Data type

Integer

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

0 - Off, no scheduled synchronization during off-peak times.

5 - 5 minutes between synchronizations during off-peak times.

10 - 10 minutes between synchronizations during off-peak times.

15 - 15 minutes between synchronizations during off-peak times.

30 - 30 minutes between synchronizations during off-peak times.

60 - 60 minutes between synchronizations during off-peak times.

120 - 120 minutes between synchronizations during off-peak times.

240 - 240 minutes between synchronizations during off-peak times.

-1 - Synchronize as new items arrive during off-peak times.

Policies/MaxPeakFrequency

This parameter sets the maximum value that can be set for the Settings/PeakFrequency property either through the Synchronization Configuration Service Provider or through the device's UI.

Data type

Integer

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

0 - Off, no scheduled synchronization during peak times.

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 off-peak times.

240 - 240 minutes between synchronizations during peak times.

-1 - Synchronize as new items arrive during peak times.

Policies/PeakEndTime

This parameter sets the value that for the Settings/PeakEndTime property. If this value is set the user cannot adjust the peak end time.

Data type

Chr

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

A valid hour and minute combination in 24-hour format

Policies/PeakStartTime

This parameter sets the value that for the Settings/PeakStartTime property. If this value is set the user cannot adjust the peak start time.

Data type

Chr

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

A valid hour and minute combination in 24-hour format

Policies/ServerName

This parameter sets the value that for the Connection/Server property. If this value is set the user cannot adjust the server name.

Data type

Chr

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

The URL of the server to be used for synchronization

Policies/SyncWhenRoaming

This parameter sets the value that for the Settings/SyncWhenRoaming property. If this value is set the user cannot change whether the device will synchronize when it is roaming.

Data type

Integer

Read/Write Access

Read/Write

Access type

Add, Get, Delete, Replace

Occurs

1

Scope

Permanent

Roles allowed to query and update setting

Manager

Values

0 - Synchronization is disabled when the device is roaming.

1 - Synchronization is enabled when the device is roaming.

The following table shows the Microsoft custom elements that this Configuration Service Provider supports for OMA Client Provisioning.

Elements Available

parm-query

Yes

noparm

No

nocharacteristic

No

characteristic-query

Yes recursive: No root level of the Configuration Service Provider: Yes

Use these elements to build standard OMA Client Provisioning (formerly WAP Client Provisioning) configuration XML. For information about specific elements, see MSPROV DTD Elements. For examples of how to generally use the Microsoft custom elements, see Provisioning XML File Examples.

For information about OMA Client Provisioning, see OMA Client Provisioning Files.

Show: