Download Configuration Service Provider

4/8/2010

The Download Configuration Service Provider enables an OMA DM server to initiate on the device downloads of .cab or Cab Provisioning Format (.cpf) files and installation of applications.

The Download Configuration Service Provider coordinates between Configuration Manager2, the Windows Mobile and the local database that tracks downloads. This Configuration Service Provider is typically used for mandatory downloads of application software and updates to support enterprise software management. It can accept both standard and Microsoft-specific parameter configuration requests and supports DownloadInstall operations.

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

The following image shows the Download Configuration Service Provider management object in tree format as used by OMA DM.

• ./Vendor/MSFT/SwMgmt/Download
  Parent characteristic for the components that are ready to download or are in the process of downloading.

  Type: com.microsoft/windowsmobile/1.0/swdownload

  Access type	Get
  Data type	node
  Occurs	One

• ./Vendor/MSFT/SwMgmt/Download/<X>
  Parent characteristic of the download parameters for a component.

  Access type	Add, Delete, Get
  Data type	node
  Occurs	ZeroOrMore

• ./Vendor/MSFT/SwMgmt/Download/<X>/PkgID
  Specifies the package ID of the deployment component. The PkgID value must be device unique or the device will fail an Add request.

  Access type	Add, Get, Replace
  Data type	chr
  Occurs	One

• ./Vendor/MSFT/SwMgmt/Download/<X>/Name
  Specifies the name of the downloadable component to display to the user. This value is used in the software install history as the name of the installed package.

  Access type	Add, Get, Replace
  Data type	chr
  Occurs	ZeroOrOne

• ./Vendor/MSFT/SwMgmt/Download/<X>/PkgURL
  Specifies the URI for the downloadable component.

  Access type	Add, Get, Replace
  Data type	chr
  Occurs	One

• ./Vendor/MSFT/SwMgmt/Download/<X>/Status
  Specifies the status of the download operation. This value is set by the OMA DM client.

  The possible values are listed in the following table.

  Value	Status	Description
  10	Idle / Start	The download is about to start. There is no data available.
  20	Download Failed	The download failed and no data was received.
  30	Download in Progress	The download has started and zero or more bytes of data have been received.
  40	Download Complete	The download has completed successfully.
  50	Install in Progress	The installation has started.
  70	Install Failed without Data	The install failed and the downloaded package has been deleted.

  Access type	Get
  Data type	int
  Occurs	One

• ./Vendor/MSFT/SwMgmt/Download/<X>/PkgType
  Specifies the MIME type of the deployment component.

  Access type	Add, Get, Replace
  Data type	chr
  Occurs	ZeroOrOne

• ./Vendor/MSFT/SwMgmt/Download/<X>/Operations
  Groups executable operations.

  Access type	Get
  Data type	node
  Occurs	One

• ./Vendor/MSFT/SwMgmt/Download/<X>/Operations/DownloadInstall
  Used with the Exec command to download the component to the device and install and activate it.

  Access type	Get, Exec
  Data type	null
  Occurs	One

• ./Vendor/MSFT/SwMgmt/Download/<X>/Ext
  Groups vendor-specific options.

  Access type	Add, Get > [!NOTE] > Implicit Add is allowed.
  Data type	node
  Occurs	ZeroOrOne

• ./Vendor/MSFT/SwMgmt/Download/<X>/Ext/Microsoft
  Groups Microsoft-specific options.

  Access type	Add, Get > [!NOTE] > Implicit Add is allowed.
  Data type	node
  Occurs	ZeroOrOne

• ./Vendor/MSFT/SwMgmt/Download/<X>/Ext/Microsoft/Description
  Contains additional information from the server for display to the user. This information is also used in the install history.

  Access type	Add, Get, Replace
  Data type	chr
  Occurs	ZeroOrOne

• ./Vendor/MSFT/SwMgmt/Download/<X>/Ext/Microsoft/PkgSize
  Specifies the download package size in bytes. This information is used in the install history.

  Access type	Add, Get, Replace
  Data type	int
  Occurs	ZeroOrOne

• ./Vendor/MSFT/SwMgmt/Download/<X>/Ext/Microsoft/NotUserRemovable
  Specifies whether the device will display the installed application in the Remove Programs dialog on the device. If TRUE, the associated application cannot be uninstalled.

  The behavior for the valid values is:

  • TRUE: The application will not be shown in the remove programs dialog.
  • FALSE: This is the default value. The security role of the certificate used to sign the application .cab file determines whether the device will display the installed application in the remove programs setting control panel. If the application has the authenticated user security role, as determined from the signature of the .cab file, then the device displays the application in the Remove Program settings control panel. If the application does not have such a role, then the device does not display the application.

  Access type	Add, Get, Replace
  Data type	bool
  Occurs	ZeroOrOne

• ./Vendor/MSFT/SwMgmt/Download/<X>/Ext/Microsoft/InstallOptions
  Specifies the options used to install the download package.

  The default and only valid value is Silent.

  When set to Silent, no download UI is displayed to the user. If the downloaded cabinet file setup.dll includes a UI, it is displayed.

  Access type	Add, Get, Replace
  Data type	chr
  Occurs	ZeroOrOne

Remarks

The Exec command starts the download and install procedure. Once the Exec command is accepted by the Configuration Service Provider, OMA status command accept code 202 is returned to the server. Any download and install related errors will be returned to the server using a generic alert. If installation succeeds, the download object is removed from the DM tree and an inventory entry is created. If the download or installation fails, the download object is not removed from the DM tree but the status code is updated.

To prevent the uncontrollable growth of stored data, the Download Configuration Service Provider periodically deletes objects it has created. This cleanup action won’t delete an object whose access is set as read-only.

See Also

Tasks

Download and Install Example

Concepts

Configuration Service Provider Reference for Windows Mobile Devices
Download DDF File