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

3/26/2014

Configuration Manager uses this XML document to update the metabase that contains security and UI text information for every setting on a Windows Embedded Compact powered device.

Syntax

<wap-provisioningdoc>
   <characteristic type="Metabase">
     <characteristic type="<SettingType>">
      <parm name="<ParmName>" value="<ParmValue>"/>
      <parm-query name="<ParmName>" />
      <noparm name="<ParmName>" />
    </characteristic>
    <nocharacteristics type="<SettingType>" />
    <characteristic-query type="<SettingType>" />
    </characteristic>
</wap-provisioningdoc>  

Elements

Element name	Description	Attributes
characteristic	Groups settings for a configuration service provider.	type The type of group. It can be one of the following: ValueDescription MetabaseIndicates the root characteristic element for the Metabase configuration service provider. labelIndicates settings for labels in the UI. optionsIndicates settings for options that are available for setting values, in different languages. <local_setting>Indicates a local setting; for example, a registry path.
parm	Metadata that describes a device setting.	name The name of the device setting to configure. It can be one of the following: ValueDescription maxlengthMaximum length. When used, the corresponding value attribute indicates the maximum number of characters possible. Available when its parent characteristic element's type is <local_setting>. maxvalueMaximum value. When used, the corresponding value attribute indicates the maximum value for the entry. You cannot use this parameter directly under the root characteristic element. Available when its parent characteristic element's type is <local_setting>. minvalueMinimum value. When used, the corresponding value attribute indicates the minimum value for the entry. You cannot use this parameter directly under the root characteristic element. Available when its parent characteristic element's type is <local_setting>. multiple Multiple options.When used, the corresponding value attribute indicates whether the user is able to select multiple options. It can be one of the following: ValueDescription 0The user cannot select multiple options. 1The user can select multiple options. You cannot use this parameter directly under the root characteristic element. If there are no options that were specified or if the control specified does not provide multi-select, this parameter is ignored. If there are multiple values in the value attribute for a parm that is contained by a characteristic element of type options, this value is set to 1.Available when its parent characteristic element's type is <local_setting>. rw-access Read/Write access roles.When used, the corresponding value attribute indicates the role(s) with Read/Write access to the entry. It can be one of the following: ValueDescription 1Read-only 2Write-only 3Read/Write You cannot use this parameter directly under the root characteristic element. Available when its parent characteristic element's type is <local_setting> or option. semantic-type Semantic type.When used, the corresponding value attribute indicates the information format in which the UI control displays its content. It can be one of the following: Semantic type MIME type emailtext/vnd.ms.emailaddress urltext/vnd.ms.url Phone-numbertext/vnd.ms.phonenumber alphanumeric-passwordtext/vnd.ms.password currencytext/vnd.ms.currency numeric-passwordtext/vnd.ms.numericpassword short-date_timetext/vnd.ms.date filetext/vnd.ms.filename texttext/plain labeltext/vnd.ms.label linktext/vnd.ms.hyperlink leveltext/vnd.ms.progressbar Available when its parent characteristic element's type is <local_setting>.The UI uses a semantic-type value to display a UI control that matches the actual semantic-type for the setting. The value of this attribute is not confined to a list. This parameter cannot be used directly under the root characteristic element. <language_code>Language code that specifies the language (for example, 0409, 0407). For possible values, see Language Identifiers. When used, the corresponding value attribute can be one of the following: When its parent characteristic element's type is label, the text for the label in the specified language. When its parent characteristic element's type is options, an option value, or semicolon (;) delineated list of option values, in the specified language. datatype Data type for this setting.When used, the corresponding value attribute can be one of the following: Value Description binBinary. The setting contains a stream of binary data (octet stream). boolBoolean. The setting contains a Boolean value. date Date. The setting contains a date. Both basic and extended date formats are supported. Note: The setting for date should be specified by date only, and not by date + time, according to the ISO 8601 standard. If the value is a date, only the date portion is returned. floatFloat. The setting contains a floating-point value. intInteger. The setting contains an integer value. mchrMultiplestring. The setting contains a multiplestring value. chr or stringString. The setting contains a string value. timeTime. Both basic and extended time formats are supported. The setting can specify either a date + time or a time-only format. If the date + time format is used, the "T" character delineates the date and time. Available when its parent characteristic element's type is label or option. 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 listed above. value On return, contains the value of the setting provided in name.
noparm	In a request document, the setting to be removed.	name Any supported name attribute listed above.
nocharacteristic	In a request document, the settings to be removed from the device.	type Any supported type attribute listed above.
characteristic-query	Use this element to query the value specified by the characteristic in the type attribute.	type Any supported type attribute listed above.

Remarks

To change settings in the metabase, or to obtain information from the metabase, you can write a provisioning XML file that you customize for the Metabase configuration service provider. However, the Metabase 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.

Individual settings can be queried, updated, or deleted. However, top-level querying and deleting settings is not supported.

Example

The following example code adds an entry (HKEY_LOCAL_MACHINE\Software\Microsoft\TestKey3) and its settings to the metabase.

<wap-provisioningdoc>
 <characteristic type="Metabase">
  <characteristic type="Registry\HKLM\Software\Microsoft\TestKey3">
      <parm name="datatype" value="integer"/>
      <parm name="maxvalue" value="30"/>
      <parm name="minvalue" value="0"/>
      <parm name="rw-access" value="3"/>
      <characteristic type="label">
        <parm name="0409" value="Test Key"/>
        <parm name="0407" value="Test-Taste"/>
        <parm name="040c" value="Clé D'Essai"/>
      </characteristic>
      <characteristic type="options">
        <parm name="0409" value="Red=1;Green=2;Blue=3"/>
        <parm name="0407" value="Rot=1;Grün=2;Blau=3"/>
        <parm name="040c" value="Rouge=1;Vert=2;Bleu=3"/>
      </characteristic>
  </characteristic>
 </characteristic>
</wap-provisioningdoc>

Requirements

See Also

Reference

Configuration Service Provider Reference
IConfigManager