CM_Planner Configuration Service Provider
The CM_Planner Configuration Service Provider configures the preferred connections for each network for Connection Manager. The CM_Planner Configuration Service Provider can also set the settings for those connections.
Note This Configuration Service Provider must be used when provisioning devices using the OMA Client Provisioning (formerly WAP) protocol. To provision devices using OMA DM, use the CMPLANNER Configuration Service Provider instead.
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 following image shows the Configuration Service Provider in tree format as used by OMA Client Provisioning.
.gif)
Characteristics
- PreferredConnections
Parameters under this characteristic specify the preferred connection to use when connecting to a specific destination network.
Parameters
<PreferredConnection>
This parameter is used in the PreferredConnections characteristic to specify the preferred connection to use when connecting to a specific destination network. The name of the parameter must be a valid destination network GUID. The value of the parameter must be the entry name of a connection, which may be the initial node on a path connecting the device to the specified destination network. For example, the xml string<parm name="{436EF144-B4FB-4863-A041-8F905A62C572}" value="PPP4" />will tell the planner to prefer the dialup connection PPP4 when connecting to the Internet.The following table shows the default settings.
Permissions Read/Write Data type String Label Internet connection: Secure WAP connection:
WAP connection:
Work connection:
Roles allowed to query and update setting Manager AuthenticatedUser
CacheTime
Specifies the default time, in seconds, for which the planner will cache released connections. The following table shows the possible values.Value Description 0 None 30 30 seconds 60 1 minute 300 5 minutes 600 10 minutes The following table shows the default settings.
Permissions Read/Write Data type Integer Label Idle disconnect after: Roles allowed to query and update setting Manager AuthenticatedUser
The Connection Manager does not cache the following types of connections:
- Suspended connections
- Disconnected connections
- Connections without a DestId (that is, when the connection was provisioned using provisioning XML, a DestId was not specified)
- Fixed path connections (that is, a connection where the destination GUID is set to be an existing network connection managed using the Connection Manager)
Caching also does not occur when ConnMgrReleaseConnection is called with the lCache parameter set to 0.
CoeffBandwidth
Specifies a bandwidth coefficient, in 16.16 fixed point, for planner path calculations. The default value is 0x10000, which corresponds to 1.0.The following table shows the default settings.
Permissions Read/Write Data type Integer Label Bandwidth Coefficient Roles allowed to query and update setting Manager AuthenticatedUser
CoeffCost
Specifies a cost coefficient, in 16.16 fixed point, for planner path calculations. The default value is 0x10000, which corresponds to 1.0.The following table shows the default settings.
Permissions Read/Write Data type Integer Label Cost Coefficient Roles allowed to query and update setting Manager AuthenticatedUser
CoeffLatency
Specifies a latency coefficient, in 16.16 fixed point, for planner path calculations. The default value is 0x10000, which corresponds to 1.0.The following table shows the default settings.
Permissions Read/Write Data type Integer Label Latency Coefficient Roles allowed to query and update setting Manager AuthenticatedUser
FailoverDefault
Sets the default value for the yes/no buttons of the failover prompt. Permitted values are 0 (no) or 1 (yes).Note The prompt has an internal timeout, so this also controls the default action if the user does not respond to the prompt within the time limit. If the failover prompt is disabled, this parameter also specifies whether failover is allowed.
The following table shows the default settings.
Permissions Read/Write Data type Boolean Roles allowed to query and update setting Manager AuthenticatedUser
FailoverPrompt
Specifies whether the planner displays a yes/no prompt before using a non-preferred connection, for example if the preferred connection is unavailable. The following table shows the possible values.Value Description 0 Do not display a prompt 1 Display a prompt The following table shows the default settings.
Permissions Read/Write Data type Boolean Roles allowed to query and update setting Manager AuthenticatedUser
RetryCount
Specifies the number of times the planner retries failed connection attempts. Possible values for this parameter are 0, 1, 2, 3, 4 and 5. A value of 0 causes the planner to fail the connection attempt after the first try. A value of 1 causes the planner to retry the connection once.The following table shows the default settings.
Permissions Read/Write Data type Integer Label Redial attempts: Roles allowed to query and update setting Manager AuthenticatedUser
Microsoft Custom Elements
The following table shows the Microsoft custom elements that this Configuration Service Provider supports for OMA Client Provisioning.
| Elements | Available |
|---|---|
| noparm | No |
| nocharacteristic | Yes |
| characteristic-query | Yes |
| parm-query | Yes |
Use these elements to build standard OMA Client Provisioning (formerly WAP) 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.
See Also
Configuration Service Provider Reference for Windows Mobile-Based Devices | CM_Planner Configuration Service Provider Examples for OMA Client Provisioning
Send Feedback on this topic to the authors