Provisioning XML Document for Clock Configuration Service Provider (Compact 2013)

  • Article

3/26/2014

Configuration Manager uses this XML document to configure the local time zones and system alarm settings on a Windows Embedded Compact powered device.

Syntax

<wap-provisioningdoc>
  <characteristic type="Clock">
     <parm name="ParmName" value="<ParmValue>" />
     <parm-query name="<ParmName>" />
  </characteristic>
</wap-provisioningdoc>

Elements

Element name

Description

Attributes

characteristic

Groups settings for a configuration service provider.
type

Set to "Clock" to indicate the root characteristic element for the Locale configuration service provider.

parm

Metadata that describes a device setting.
name

The name of the device setting to configure. It can be one of the following:

ValueDescription
AlarmOn
The state of the first system alarm (Alarm 1). When used, the value of the corresponding value attribute must be one of the following:

Integer valueDescription
0Turns off the alarm.
1Turns on the alarm (every day).
2Turns on the alarm (weekdays only).
3Turns on the alarm (weekends only).
AlarmOn2
The state of the second system alarm (Alarm 2).When used, the value of the corresponding value attribute must be one of the following:

Integer valueDescription
0Turns off the alarm.
1Turns on the alarm (every day).
2Turns on the alarm (weekdays only).
3Turns on the alarm (weekends only).
Alarm Time
The alarm time for the first system alarm (Alarm 1). When used, the value of the corresponding value attribute is a string in ISO 8601 standard date/time format, as follows: 
[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]
The alarm time will be adjusted to the time zone that is set on the device.See Remarks for more information.
AlarmTime2
The alarm time for the second system alarm (Alarm 2). When used, the value of the corresponding value attribute is a string in ISO 8601 standard date/time format, as follows: 
[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]
The alarm time will be adjusted to the time zone that is set on the device.See Remarks for more information.
Date
The system date. When used, the value of the corresponding value attribute is a string in ISO 8601 standard date/time format, as follows: 
[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]
See Remarks for more information.
Time
The system time. When used, the value of the corresponding value attribute is the string in ISO 8601 standard date/time format, as follows: 
[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]
See Remarks for more information.
TimeZoneThe current time zone on the device's operating system. For the possible values in Windows Embedded Compact 2013, see Time Zone IDs.
value

See descriptions in name attribute for possible values.

parm-query

Specifies a request for the current value of a setting.
name

Any supported name attribute that is listed above.

value

On return, contains the value of the specified name attribute.

Remarks

To change device settings for the clock, you can write a provisioning XML file. However, the Clock configuration service provider supports only a subset of elements and its own attribute values for the characteristic and parm elements.

For more information about elements, see Provisioning XML Document.

All date and time strings are in the Coordinated Universal Time (UTC) time format, and a leading 0 (zero) is required if the hour is less than 10.

For example, 06:00:00Z represents an alarm setting of 6:00 AM.

For example, 2010-10-04T13:45:59Z represents 4 October 2010 at 1:45:59 PM.

In this example, "Z" specifies Coordinated Universal Time, which uses the 24-hour numbering system.

Example

The following example code sets the time zone on the device.

Important

For readability, the following code example does not contain security checking or error handling. Do not use the following code in a production environment.

<wap-provisioningdoc>
  <characteristic type="Clock">
     <parm name="AlarmOn" value=1/>
     <parm name="AlarmTime" value="2010-10-04T13:45:59Z"/>
     <parm name="Date" value="2010-10-04"/>
     <parm name="Time" value="06:00:00Z"/>
     <parm name="TimeZone" value="4"/>
  </characteristic>
</wap-provisioningdoc>

Requirements

sysgen

SYSGEN_DMSRV,
SYSGEN_SYSCSPS_CLOCKCSP

See Also

Reference

Configuration Service Provider Reference
IConfigManager