w7 APPLICATION Configuration Service Provider

4/8/2010

The APPLICATION configuration service provider that has an APPID of w7 is used for bootstrapping a device with an OMA DM account. This configuration service provider is managed over the OMA DM 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 default security roles are defined in the root characteristic. The default security role maps to each subnode unless specific permission is granted to the subnode. The following table shows the default settings:

Access type	Read/Write
Roles allowed to query and update setting	Manager Operator Operator - TPS

The following image shows the configuration service provider in tree format as used by OMA DM.

Characteristics

• APPADDR
  This characteristic is used in the w7 APPLICATION characteristic to specify the DM server address

• APPAUTH
  This characteristic is used in the w7 APPLICATION characteristic to specify authentication information

• PORT
  This characteristic is used in the APPADDR characteristic to specify port information.

Parameters

• AAUTHDATA
  The AAUTHDATA parameter is used in the APPAUTH characteristic to provide additional data used in authentication. This parameter is used to convey the nonce for digest authentication type. The value of this parameter is a base64-encoded in the form of a series of bytes.

  The following table shows the default settings for both subnodes.

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne

• AAUTHLEVEL
  The AAUTHLEVEL parameter is used in the APPAUTH characteristic to indicate whether credentials are for server authentication or client authentication.

  The valid values are:

  • APPSRV specifies that the client authenticates itself to the OMA DM Server at the DM protocol level.
  • CLIENT specifies that the server authenticates itself to the OMA DM Client at the DM protocol level.

  The following table shows the default settings for both subnodes.

  Access type	Read/Write
  Data type	string
  Occurs	One

• AAUTHSECRET
  The AAUTHSECRET parameter is used in the APPAUTH characteristic to provide the authentication secret used to authenticate the user.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	One

• AAUTHTYPE
  The AAUTHTYPE parameter of the APPAUTH characteristic is used to indicate the method of authentication.

  The valid values are:

  • BASIC specifies that the SyncML DM 'syncml:auth-basic' authentication type.
  • DIGEST specifies that the SyncML DM 'syncml:auth-md5' authentication type. When AAUTHLEVEL is CLIENT, then AAUTHTYPE must be DIGEST.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne

• ADDR
  The ADDR parameter is used in the APPADR characteristic to provide the address of the OMA DM server.

  The valid values for the ADDRTYPE parameter are:

  • An IPV6 address in hexadecimal numbers with colons as delimiters or a combination of hexadecimal and decimal numbers with dots and colons as delimiters
  • A phone number according to the E164 scheme
  • A generic alphanumeric address as defined by alphanum in RFC2396

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrMore

• ADDRTYPE
  The ADDRTYPE parameter is used in the APPADDR Characteristic to specify the format of the ADDR parameter.

  The valid values for the ADDRTYPE parameter are: IPV6, E164, or ALPHA.

  In OMA DM XML, if there are multiple instances of this parameter, the first valid parameter value is used.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrMore

• APPID
  The APPID parameter is used in the APPLICATION characteristic to differentiate the types of available application services and protocols.

  The only valid value to configure the OMA Client Provisioning bootstrap APPID is w7.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	One

• BACKCOMPATRETRYDISABLED
  The BACKCOMPATRETRYDISABLED parameter is used in the APPLICATION characteristic to specify whether to retry resending a package with an older protocol version (for example, 1.1) in the SyncHdr (not including the first time).

  Note

  This parameter doesn’t contain a value. The existence of this parameter means back compat retry is disabled. If the parameter is missing, it means back compat retry is enabled.

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne

• CONNRETRYFREQ
  The CONNRETRYFREQ parameter is used in the APPLICATION characteristic to specify how many retries the DM client performs when there are Connection Manager level or wininet level errors.

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne
  Default value	3

• DEFAULTENCODING
  The DEFAULTENCODING parameter is used in the APPLICATION characteristic to specify whether the DM client should use WBXML or XML for the DM package when communicating with the server. The valid values are:

  • application/vnd.syncml.dm+xml (Default)
  • application/vnd.syncml.dm+wbxml

  For more information about encoding in OMA DM protocol, see WBXML and OMA DM.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne

• INIT
  The INIT parameter is used in the APPLICATION characteristic to indicate that the management server wants the client to initiate a management session immediately after settings approval. If the current w7 APPLICATION document will be put in ROM, the INIT parameter must not be present.

  Note

  This parameter forces the device to attempt to connect with the OMA DM server. The connection attempt fails if the XML is set during the coldinit phase. A common cause of this failure is that immediately after coldinit is finished the radio is not yet ready.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne

• INITIALBACKOFFTIME
  The INITIALBACKOFFTIME parameter is used in the APPLICATION characteristic to specify the initial wait time in milliseconds when the DM client retries for the first time. The wait time grows exponentially.

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne
  Default value	16000

• MAXBACKOFFTIME
  The MAXBACKOFFTIME parameter is used in the APPLICATION characteristic to specify the maximum number of milliseconds to sleep after package-sending failure.

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne
  Default value	86400000

• NAME
  The NAME parameter is used in the APPLICATION characteristic to specify a user readable application identity. This parameter is used to define part of the registry path for the APPLICATION parameters.

  The NAME parameter can be a string or null (no value). If no value is specified, the registry location will default to <unnamed>.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne

• PORTNBR
  The PORTNBR parameter is used in the PORT characteristic to identify the port number to connect to.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	One

• PROTOVER
  The PROTOVER parameter is used in the APPLICATION characteristic to specify the OMA DM Protocol version the server supports. No default value is assumed. The protocol version set by this node will match the protocol version that the DM client reports to the server in SyncHdr in package 1. If this node is not specified when adding a DM server account, the latest DM protocol version that the client supports is used. In Windows Mobile 6.5 powered devices this is 1.2. This is a Microsoft custom parameter.

  The valid values to configure the PORTNBR parameter are: 1.1 or 1.2.

  For more information about the PROTOVER parameter, see Device Management Migration from Windows Mobile Version 5.0.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	chr
  Occurs	ZeroOrOne

• PROVIDER-ID
  The PROVIDER-ID parameter is used in the APPLICATION characteristic to differentiate OMA DM servers. It specifies the server identifier for a management server used in the current management session.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne

• ROLE
  The ROLE parameter is used in the APPLICATION characteristic to specify the security role mask the DM session should run with when communicating with the DM server. If this parameter is not present, the DM session is given the role mask that the w7 APPLICATION document is running with. This is a Microsoft custom parameter.

  For information about role masks, see Security Policy Settings.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne

• SSLCLIENTCERTSEARCHCRITERIA
  The SSLCLIENTCERTSEARCHCRITERIA parameter is used in the APPLICATION characteristic to specify the client certificate search criteria. This parameter supports search by subject attribute and certificate stores. If any other criteria are provided, it is ignored.

  The string is a concatenation of name/value pairs, each member of the pair delimited by the "&" character. The name and values are delimited by the "=" character. If there are multiple values, each value is delimited by the Unicode character "U+F000". If the name or value contains characters not in the UNRESERVED set (as specified in RFC2396), then those characters are URI-escaped per the RFC.

  The supported names are Subject and Stores.

  Stores specifies which certificate stores the DM client will search to find the SSL client certificate, system store, or user store. If both the system and user store are specified in the parameter, then the client searches the system store first and then searches the user store if a valid certificate cannot be found in the system store. The store name is not case sensitive.

  Valid store values are MY\System, MY\User, MY\System%EF%80%80MY\User, MY\User%EF%80%80MY\System

  The default store value is System\MY.

  Note

  "" needs to be escaped in SyncXML.

  Note

  %EF%80%80 is the UTF8-encoded character U+F000.

  Subject value specifies the certificate to search for.

  For example, to specify that you want a certificate with a particular Subject attribute (“CN=hdang,O=Microsoft”) in the HKLM and HKCU MY stores, use the following:

  <parm name=”SSLCLIENTCERTSEARCHCRITERIA” value=”Subject=CN%3Dhdang,O%3DMicrosoft&Stores=MY%5CSystem%EF%80%80MY%5CUser” />

  Note

  The SSLCLIENTCERTSEARCHCRITERIA value is case sensitive.

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrOne

• TO-NAPID
  The TO-NAPID parameter is used in the APPLICATION characteristic to specify the Network Access Point the client will use to connect to the OMA DM server. If multiple TO-NAPID parameters are specified, only the first TO-NAPID value will be stored.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	string
  Occurs	ZeroOrMore

• USEHWDEVID
  The USEHWDEVID parameter is used in the APPLICATION characteristic to specify use of device hardware identification. It does not have a value.

  • If the parameter is not present, the default behavior is to use an application-specific GUID used rather than the hardware device ID.
  • If the parameter is present, the hardware device ID will be provided at the ./DevInfo/DevID node and in the Source LocURI for the DM package sent to the server. International Mobile Subscriber Identity (IMEI) is returned for a GSM device, the Electronic Serial Number (ESN) is returned for a CDMA device, and a GUID is returned for a non-radio device. For more information about these values and their format, see DevInfo Configuration Service Provider.

  For information about how to bootstrap a device to return the hardware ID, see Bootstrapping To Return the Device Hardware ID.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	null
  Roles allowed to query this setting	Manager Operator - TPS
  Occurs	ZeroOrOne

• USENONCERESYNC
  The USENONCERESYNC parameter is used in the APPLICATION characteristic to indicate optional use of nonce resynchronization to attempt to recover from authentication failures. This is a Microsoft custom parameter. It does not have a value.

  • If this parameter does not exist, there is no resynchronization attempt. If authentication of the server notification message fails the device discards the message and does not connect to the server. This is the default behavior.
  • If this parameter exists, when authentication of the server notification message fails the device attempts to use the resynchronization protocol with the OMA DM version 1.2 server.

  For more information about nonce resynchronization, see OMA DM MD5 Authentication Nonce.

  The following table shows the default settings:

  Access type	Read/Write
  Data type	null
  Roles allowed to query this setting	Manager Operator - TPS
  Occurs	ZeroOrOne

See Also

Tasks

w7 APPLICATION Configuration Service Provider Example for OMA Client Provisioning

Reference

APPLICATION Configuration Service Provider
w7 APPLICATION

Concepts

Bootstrapping To Use An OMA DM Server