Metabase Configuration Service Provider

4/8/2010

Use the Metabase Configuration Service Provider to add, modify, and remove entries from the metabase.

The metabase (metadata database) contains specific information about the Configuration Service Providers on a Windows® phone. The metadata includes settings, possible values, information about how to display parameters that are configurable through certain Configuration Service Providers, role requirements and mappings for each setting and Configuration Service Provider, and other relevant information about them. Individual settings can be queried, updated, or deleted; however, top-level query and deletion is not supported.

Each Configuration Service Provider setting is updated as a metabase configuration file is processed. This allows new setting values in subsequent settings within the file to be used. For example, a security setting could be changed so that the next parameter could make use of the new security role information.

Bb737399.security(en-us,MSDN.10).gifSecurity Note:
The Metabase Configuration Service Provider is set to the Manager role by default. Changing this role could elevate privileges, making the metabase less secure.

This Configuration Service Provider is managed over the OMA Client Provisioning (formerly WAP Client Provisioning) protocol.

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 about roles, see Security Roles and Default Roles for Configuration Service Providers.

The Metabase Configuration Service Provider also supports the <language code> parameter, which allows localized text to be used on the device.

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

Access type

Read/write

Roles allowed to query and update setting

Manager

Characteristics

  • label
    Provides user-friendly language labels in the user interface.
  • options
    Groups option values that are available for this specific entry in different languages.

Parameters

  • <language code>
    This parameter is used in the label characteristic to identify the text for the label in a specific language, and in the option characteristic to identify the code for that language. The following table lists the possible hexadecimal values for this parameter.

    Value Description

    0001

    Arabic

    0004

    Chinese

    0009

    English

    0401

    Arabic (Saudi Arabia)

    0402

    Bulgarian

    0403

    Catalan

    0404

    Chinese (Taiwan)

    0405

    Czech

    0406

    Danish

    0407

    German (Germany)

    0408

    Greek

    0409

    English (United States)

    040A

    Spanish (Traditional Sort)

    040B

    Finnish

    040C

    French (France)

    040D

    Hebrew

    040E

    Hungarian

    040F

    Icelandic

    0410

    Italian (Italy)

    0411

    Japanese

    0412

    Korean

    0413

    Dutch (Netherlands)

    0414

    Norwegian (Bokmal)

    0415

    Polish

    1416

    Portuguese (Brazil)

    0417

    Rhaeto-Romanic

    0418

    Romanian

    0419

    Russian

    041A

    Croatian

    041B

    Slovak

    041C

    Albanian

    041D

    Swedish

    041E

    Thai

    041F

    Turkish

    0420

    Urdu

    0421

    Indonesian

    0422

    Ukrainian

    0423

    Belarusian

    0424

    Slovenian

    0425

    Estonian

    0426

    Latvian

    0427

    Lithuanian

    0429

    Farsi

    042A

    Vietnamese

    042D

    Basque

    042E

    Sorbian

    042F

    F.Y.R.O. Macedonia

    0430

    Sutu

    0431

    Tsonga

    0432

    Tswana

    0434

    Xhosa

    0435

    Zulu

    0436

    Afrikaans

    0438

    Faeroese

    0439

    Hindi

    043A

    Maltese

    043C

    Scottish Gaelic (United Kingdom)

    043D

    Yiddish

    043E

    Malay (Malaysia)

    0456

    Galician (Spain)

    0801

    Arabic (Iraq)

    0804

    Chinese (PRC)

    0807

    German (Switzerland)

    0809

    English (United Kingdom)

    080A

    Spanish (Mexico)

    080C

    French (Belgium)

    0810

    Italian (Switzerland)

    0813

    Dutch (Belgium)

    0814

    Norwegian (Nynorsk)

    0816

    Portuguese (Portugal)

    0818

    Romanian (Moldova)

    0819

    Russian (Moldova)

    081A

    Serbian (Latin)

    081D

    Swedish (Finland)

    0C01

    Arabic (Egypt)

    0C04

    Chinese (Hong Kong SAR)

    0C07

    German (Austria)

    0C09

    English (Australia)

    0C0A

    Spanish (International Sort)

    0C0C

    French (Canada)

    0C1A

    Serbian (Cyrillic)

    1001

    Arabic (Libya)

    1004

    Chinese (Singapore)

    1007

    German (Luxembourg)

    1009

    English (Canada)

    100A

    Spanish (Guatemala)

    100C

    French (Switzerland)

    1401

    Arabic (Algeria)

    1407

    German (Liechtenstein)

    1409

    English (New Zealand)

    140A

    Spanish (Costa Rica)

    140C

    French (Luxembourg)

    1801

    Arabic (Morocco)

    1809

    English (Ireland)

    180A

    Spanish (Panama)

    1C01

    Arabic (Tunisia)

    1C09

    English (South Africa)

    1C0A

    Spanish (Dominican Republic)

    2001

    Arabic (Oman)

    2009

    English (Jamaica)

    200A

    Spanish (Venezuela)

    2401

    Arabic (Yemen)

    240A

    Spanish (Colombia)

    2801

    Arabic (Syria)

    2809

    English (Belize)

    280A

    Spanish (Peru)

    2C01

    Arabic (Jordan)

    2C09

    English (Trinidad)

    2C0A

    Spanish (Argentina)

    3001

    Arabic (Lebanon)

    300A

    Spanish (Ecuador)

    3401

    Arabic (Kuwait)

    340A

    Spanish (Chile)

    3801

    Arabic (U.A.E.)

    380A

    Spanish (Uruguay)

    3C01

    Arabic (Bahrain)

    3C0A

    Spanish (Paraguay)

    4001

    Arabic (Qatar)

    400A

    Spanish (Bolivia)

    440A

    Spanish (El Salvador)

    480A

    Spanish (Honduras)

    4C0A

    Spanish (Nicaragua)

    500A

    Spanish (Puerto Rico)

  • access-role
    This parameter is used with the label and options characteristics as a decimal value that identifies access roles. Access roles determine which security roles are allowed to access a metabase entry. Each access role is a number formed by a bitwise or from the security roles that have access to the entry. More than one role can be set for the entry. This parameter cannot be used directly under the root characteristic.

    For a list of possible security roles and corresponding role values, see Security Roles.

  • datatype
    This parameter is used with the label and options characteristics to identify the type of data handled by this setting. This parameter cannot be used directly under the root characteristic. The following table lists the possible values.

    Value Description

    bin

    Binary. The setting contains a stream of binary data (octet stream).

    bool

    Boolean. 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 will be returned.

    float

    Float. The setting contains a floating point value.

    int

    Integer. The setting contains an integer value.

    mchr

    Multiplestring. The setting contains a multiplestring value.

    chr or string

    String. The setting contains a string value.

    time

    Time. The setting contains a time. 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 then a 'T' must appear between the date and time as a delimiter.

    For more information about data types see Metabase Settings and Metabase and OMA DM.

  • maxlength
    This parameter is used with the local and options characteristics to represent the maximum number of characters the value of this parameter may have. This parameter cannot be used directly under the root characteristic.
  • maxvalue
    This parameter is used with the label and options characteristics to identify the maximum value for the entry. This parameter cannot be used directly under the root characteristic.
  • minvalue
    This parameter is used with the label and options characteristics to identify the minimum value for the entry. This parameter cannot be used directly under the root characteristic.
  • multiple
    This parameter is used with the local and options characteristics to specify whether the user is allowed to select multiple options. This parameter cannot be used directly under the root characteristic. The following table lists the possible values.

    Value Description

    0

    The user is not allowed to select multiple options.

    1

    The user is allowed to select multiple options.

    If there are no options specified or if the control specified does not allow multi-select, then this parameter is ignored. If there are multiple values in the value attribute, this parameter is also set to 1.

  • rw-access
    This parameter is used with the local and options characteristics to identify the role(s) with Read/Write access to the entry. This parameter cannot be used directly under the root characteristic. The following table lists the possible values.

    Value Description

    1

    Read-only

    2

    Write-only

    3

    Read/Write

    Nodes in Configuration Service Providers that support external transaction should not be set as write-only. **

  • semantic-type
    This parameter is used with the local and options characteristics. It allows the UI to provide a specialized control to better match the actual semantic type of the setting. The value of this attribute is not confined to a list. This parameter cannot be used directly under the root characteristic. Some of the values used by UI control are as follows: email, alphanumeric-password, numeric-password, currency, url, file, text, phone-number, invisible.

Microsoft Custom Elements

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

Elements Available

parm-query

Yes

noparm

Yes

nocharacteristic

Yes

Top level: No

characteristic-query

Yes

Recursive: Yes

Top level: No

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 use the Microsoft custom elements, see OMA Client Provisioning XML File Examples.

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

See Also

Tasks

Metabase Configuration Service Provider Examples for OMA Client Provisioning

Concepts

Configuration Service Provider Reference for Windows Mobile Devices
Metabase Settings