Download DDF File

4/8/2010

This topic shows the Device Description Framework (DDF) file for the Download Configuration Service Provider.

OMA DM DDF files and the example in this topic are used only for OMA DM provisioning. For more information, see OMA Device Management.

Note

The first line of the DDF is the namespace reference for Microsoft custom properties. For more information, see Managing Microsoft Custom Properties (OMA DM).

<MgmtTree xmlns:MSFT="https://schemas.microsoft.com/MobileDevice/DM">
  <VerDTD>1.2</VerDTD>
  <Node>
    <NodeName>Download</NodeName>
    <Path>./Vendor/MSFT/SwMgmt</Path>
    <DFProperties>
      <AccessType>
        <Get />
      </AccessType>
      <Description>The root node for software download object.</Description>
      <DFFormat>
        <node />
      </DFFormat>
      <Occurrence>
        <One />
      </Occurrence>
      <Scope>
        <Permanent />
      </Scope>
      <DFType>
        <DDFName>com.microsoft/windowsmobile/1.0/swdownload</DDFName>
      </DFType>
      <MSFT:AccessRole>8</MSFT:AccessRole>
      <MSFT:RWAccess>1</MSFT:RWAccess>
    </DFProperties>
    <Node>
      <NodeName></NodeName>
      <DFProperties>
        <AccessType>
          <Add />
          <Get />
          <Delete />
        </AccessType>
        <Description>This node is a parent node of the Download parameters for a download package.</Description>
        <DFFormat>
          <node />
        </DFFormat>
        <Occurrence>
          <ZeroOrMore />
        </Occurrence>
        <Scope>
          <Dynamic />
        </Scope>
        <DFType>
          <DDFName></DDFName>
        </DFType>
        <MSFT:RWAccess>3</MSFT:RWAccess>
      </DFProperties>
      <Node>
        <NodeName>PkgID</NodeName>
        <DFProperties>
          <AccessType>
            <Add />
            <Get />
            <Replace />
          </AccessType>
          <Description>This leaf node specifies the package ID for a downloadable package.</Description>
          <DFFormat>
            <chr />
          </DFFormat>
          <Occurrence>
            <One />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <MIME>text/plain</MIME>
          </DFType>
          <MSFT:RWAccess>3</MSFT:RWAccess>
        </DFProperties>
      </Node>
      <Node>
        <NodeName>Name</NodeName>
        <DFProperties>
          <AccessType>
            <Add />
            <Get />
            <Replace />
          </AccessType>
          <Description>This leaf node specifies the human readable name of download package.</Description>
          <DFFormat>
            <chr />
          </DFFormat>
          <Occurrence>
            <ZeroOrOne />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <MIME>text/plain</MIME>
          </DFType>
          <MSFT:RWAccess>3</MSFT:RWAccess>
        </DFProperties>
      </Node>
      <Node>
        <NodeName>PkgURL</NodeName>
        <DFProperties>
          <AccessType>
            <Add />
            <Get />
            <Replace />
          </AccessType>
          <Description>This leaf node specifies the URI of download package.</Description>
          <DFFormat>
            <chr />
          </DFFormat>
          <Occurrence>
            <One />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <MIME>text/plain</MIME>
          </DFType>
          <MSFT:RWAccess>3</MSFT:RWAccess>
        </DFProperties>
      </Node>
      <Node>
        <NodeName>Status</NodeName>
        <DFProperties>
          <AccessType>
            <Get />
          </AccessType>
          <Description>This leaf node specifies the Status of the download and install operation. This value is set by the client. Valid values are: 10-Idle/Start. 20-Download failed. 30-Download progressing. 40-Download complete. 50-Install progressing. 70- Install failed and package is deleted. </Description>
          <DFFormat>
            <int />
          </DFFormat>
          <Occurrence>
            <One />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <MIME>text/plain</MIME>
          </DFType>
          <MSFT:RWAccess>3</MSFT:RWAccess>
        </DFProperties>
      </Node>
      <Node>
        <NodeName>PkgType</NodeName>
        <DFProperties>
          <AccessType>
            <Add />
            <Get />
            <Replace />
          </AccessType>
          <Description>This leaf node specifies the MIME type of a deployed Deployment Component in the device.</Description>
          <DFFormat>
            <chr />
          </DFFormat>
          <Occurrence>
            <ZeroOrOne />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <MIME>text/plain</MIME>
          </DFType>
          <MSFT:RWAccess>3</MSFT:RWAccess>
        </DFProperties>
      </Node>
      <Node>
        <NodeName>Operations</NodeName>
        <DFProperties>
          <AccessType>
            <Get />
          </AccessType>
          <Description>This node is a parent node that groups the executable operations.</Description>
          <DFFormat>
            <node />
          </DFFormat>
          <Occurrence>
            <One />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <DDFName></DDFName>
          </DFType>
          <MSFT:RWAccess>3</MSFT:RWAccess>
        </DFProperties>
        <Node>
          <NodeName>DownloadInstall</NodeName>
          <DFProperties>
            <AccessType>
              <Exec />
              <Get />
            </AccessType>
            <Description>This node is used with Exec command to start the Download operation and install and activate the Deployment Component; to download the Deployment Component into the device and install and activate it into Active state.</Description>
            <DFFormat>
              <null />
            </DFFormat>
            <Occurrence>
              <One />
            </Occurrence>
            <Scope>
              <Dynamic />
            </Scope>
            <DFType>
              <MIME>text/plain</MIME>
            </DFType>
            <MSFT:RWAccess>3</MSFT:RWAccess>
          </DFProperties>
        </Node>
      </Node>
      <Node>
        <NodeName>Ext</NodeName>
        <DFProperties>
          <AccessType>
            <Add />
            <Get />
          </AccessType>
          <Description>This node is used to group the vendor specific options.</Description>
          <DFFormat>
            <node />
          </DFFormat>
          <Occurrence>
            <ZeroOrOne />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <DDFName></DDFName>
          </DFType>
          <MSFT:RWAccess>3</MSFT:RWAccess>
        </DFProperties>
        <Node>
          <NodeName>Microsoft</NodeName>
          <DFProperties>
            <AccessType>
              <Add />
              <Get />
            </AccessType>
            <Description>This node is used to group Microsoft specific options.</Description>
            <DFFormat>
              <node />
            </DFFormat>
            <Occurrence>
              <ZeroOrOne />
            </Occurrence>
            <Scope>
              <Dynamic />
            </Scope>
            <DFType>
              <DDFName></DDFName>
            </DFType>
            <MSFT:RWAccess>3</MSFT:RWAccess>
          </DFProperties>
          <Node>
            <NodeName>Description</NodeName>
            <DFProperties>
              <AccessType>
                <Add />
                <Get />
                <Replace />
              </AccessType>
              <Description>This node is used to specify the additional information that the server wants to notify the user in Software installation history UI.</Description>
              <DFFormat>
                <chr />
              </DFFormat>
              <Occurrence>
                <ZeroOrOne />
              </Occurrence>
              <Scope>
                <Dynamic />
              </Scope>
              <DFType>
                <MIME>text/plain</MIME>
              </DFType>
              <MSFT:RWAccess>3</MSFT:RWAccess>
            </DFProperties>
          </Node>
          <Node>
            <NodeName>PkgSize</NodeName>
            <DFProperties>
              <AccessType>
                <Add />
                <Get />
                <Replace />
              </AccessType>
              <Description>This node is used to specify the download package size in bytes.</Description>
              <DFFormat>
                <int />
              </DFFormat>
              <Occurrence>
                <ZeroOrOne />
              </Occurrence>
              <Scope>
                <Dynamic />
              </Scope>
              <DFType>
                <MIME>text/plain</MIME>
              </DFType>
             <MSFT:RWAccess>3</MSFT:RWAccess>
            </DFProperties>
          </Node>
          <Node>
            <NodeName>NotUserRemovable</NodeName>
            <DFProperties>
              <AccessType>
                <Add />
                <Get />
                <Replace />
              </AccessType>
              <Description>This node is used to specify whether to show the installed application in the Remove Program control panel. 
Valid values:
False (default) - the installed application will show in the Remove Program control panel depending on whether the user has correct security role required for processing the cab (cab's security role is decided by the signature of cab file).
True - the application will not be shown in the Remove Program Control Panel.</Description>
              <DFFormat>
                <bool />
              </DFFormat>
              <Occurrence>
                <ZeroOrOne />
              </Occurrence>
              <Scope>
                <Dynamic />
              </Scope>
              <DFType>
                <MIME>text/plain</MIME>
              </DFType>
              <MSFT:RWAccess>3</MSFT:RWAccess>
            </DFProperties>
          </Node>
          <Node>
            <NodeName>InstallOptions</NodeName>
            <DFProperties>
              <AccessType>
                <Add />
                <Get />
                <Replace />
              </AccessType>
              <Description>This node is used to specify the installation options. Valid values: Silent – This is the default value. Download and installation progress UI are suppressed. However, UI displayed by the cab’s setup.dll is not affected.</Description>
              <DFFormat>
                <chr />
              </DFFormat>
              <Occurrence>
                <One />
              </Occurrence>
              <Scope>
                <Dynamic />
              </Scope>
              <DFType>
                <MIME>text/plain</MIME>
              </DFType>
              <MSFT:RWAccess>3</MSFT:RWAccess>
            </DFProperties>
          </Node>
        </Node>
      </Node>
    </Node>
  </Node>
</MgmtTree>

See Also

Reference

Download Configuration Service Provider