Share via


Inventory DDF File

4/8/2010

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

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 file 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>Inventory</NodeName>
    <Path>./Vendor/MSFT/SwMgmt</Path>
    <DFProperties>
      <AccessType>
        <Get />
      </AccessType>
      <Description>The root node for software inventory object.</Description>
      <DFFormat>
        <node />
      </DFFormat>
      <Occurrence>
        <One />
      </Occurrence>
      <Scope>
        <Permanent />
      </Scope>
      <DFType>
        <DDFName>com.microsoft/windowsmobile/1.0/swinventory</DDFName>
      </DFType>
      <MSFT:RWAccess>1</MSFT:RWAccess>
    </DFProperties>
    <Node>
    <NodeName>Deployed</NodeName>
    <DFProperties>
      <AccessType>
        <Get />
      </AccessType>
      <Description>The root node for deployed objects.</Description>
      <DFFormat>
        <node />
      </DFFormat>
      <Occurrence>
        <One />
      </Occurrence>
      <Scope>
        <Permanent />
      </Scope>
      <DFType>
        <DDFName></DDFName>
      </DFType>
      <MSFT:RWAccess>1</MSFT:RWAccess>
    </DFProperties>
    <Node>
      <NodeName></NodeName>
      <DFProperties>
        <AccessType>
          <Get />
        </AccessType>
        <Description>This node acts as a placeholder for the deployed Deployment Components in the device.</Description>
        <DFFormat>
          <node />
        </DFFormat>
        <Occurrence>
          <ZeroOrMore />
        </Occurrence>
        <Scope>
          <Dynamic />
        </Scope>
        <DFType>
          <DDFName></DDFName>
        </DFType>
        <MSFT:RWAccess>1</MSFT:RWAccess>
      </DFProperties>
      <Node>
        <NodeName>ID</NodeName>
        <DFProperties>
          <AccessType>
            <Get />
          </AccessType>
          <Description>This node specifies the ID of a deployed Deployment Component in the device and it is locally unique.</Description>
          <DFFormat>
            <chr />
          </DFFormat>
          <Occurrence>
            <One />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <MIME>text/plain</MIME>
          </DFType>
          <MSFT:RWAccess>1</MSFT:RWAccess>
        </DFProperties>
      </Node>
      <Node>
        <NodeName>Name</NodeName>
        <DFProperties>
          <AccessType>
            <Get />
          </AccessType>
          <Description>This leaf node specifies the Name of a deployed Deployment Component in the device. The value of this node is the installed applications name that is specified in installation cab field.</Description>
          <DFFormat>
            <chr />
          </DFFormat>
          <Occurrence>
            <One />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <MIME>text/plain</MIME>
          </DFType>
          <MSFT:RWAccess>1</MSFT:RWAccess>
        </DFProperties>
      </Node>
      <Node>
        <NodeName>State</NodeName>
        <DFProperties>
          <AccessType>
            <Get />
          </AccessType>
          <Description>This leaf node specifies the state of the application, either Active or Inactive. For WM device, the only accepted value is: Active.</Description>
          <DFFormat>
            <chr />
          </DFFormat>
          <Occurrence>
            <One />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <MIME>text/plain</MIME>
          </DFType>
          <MSFT:RWAccess>1</MSFT:RWAccess>
        </DFProperties>
      </Node>
      <Node>
        <NodeName>Status</NodeName>
        <DFProperties>
          <AccessType>
            <Get />
          </AccessType>
          <Description>This leaf node specifies the current state of the application removal. The valid values are:
10: Idle/Start
20: Remove failed
30: Remove in progress</Description>
          <DFFormat>
            <int />
          </DFFormat>
          <Occurrence>
            <One />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <MIME>text/plain</MIME>
          </DFType>
          <MSFT:RWAccess>1</MSFT:RWAccess>
        </DFProperties>
      </Node>
      <Node>
        <NodeName>PkgIDRef</NodeName>
        <DFProperties>
          <AccessType>
            <Get />
          </AccessType>
          <Description>This leaf node specifies the package ID that was sent to the device during installation when this component was installed. This node has the same value as the corresponding PkgID node in Download tree. 
If the package is not delivered over SCOMO remote session, for example no Download tree is generated, the value of this node is empty.</Description>
          <DFFormat>
            <chr />
          </DFFormat>
          <Occurrence>
            <One />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <MIME>text/plain</MIME>
          </DFType>
          <MSFT:RWAccess>1</MSFT:RWAccess>
        </DFProperties>
      </Node>
      <Node>
        <NodeName>Operations</NodeName>
        <DFProperties>
          <AccessType>
            <Get />
          </AccessType>
          <Description>This node is a parent node for Operations that can be executed for deployed Deployment Component in the device.</Description>
          <DFFormat>
            <node />
          </DFFormat>
          <Occurrence>
            <One />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <DDFName></DDFName>
          </DFType>
          <MSFT:RWAccess>1</MSFT:RWAccess>
        </DFProperties>
        <Node>
          <NodeName>Remove</NodeName>
          <DFProperties>
            <AccessType>
              <Exec />
              <Get />
            </AccessType>
            <Description>This node is used with an Exec command to start a Remove operation; to Remove the deployed Deployment Component from the Software Component Management framework. 
Presence of this node indicates that the application can be removed. 
When Exec command is received, if the Configuration Service Provider successfully accepted this request, status code 202 is returned to the server. The actual un-installation result will be sent back to the server by using a generic alert through a client-initiated DM session.</Description>
            <DFFormat>
              <null />
            </DFFormat>
            <Occurrence>
              <ZeroOrOne />
            </Occurrence>
            <Scope>
              <Dynamic />
            </Scope>
            <DFType>
              <MIME>text/plain</MIME>
            </DFType>
            <MSFT:RWAccess>3</MSFT:RWAccess>
          </DFProperties>
        </Node>
      </Node>
      <Node>
        <NodeName>Ext</NodeName>
        <DFProperties>
          <AccessType>
            <Get />
          </AccessType>
          <Description>This node is a parent node to cover vendor extensions.</Description>
          <DFFormat>
            <node />
          </DFFormat>
          <Occurrence>
            <One />
          </Occurrence>
          <Scope>
            <Dynamic />
          </Scope>
          <DFType>
            <DDFName></DDFName>
          </DFType>
          <MSFT:RWAccess>1</MSFT:RWAccess>
        </DFProperties>
        <Node>
          <NodeName>Microsoft</NodeName>
          <DFProperties>
            <AccessType>
              <Get />
            </AccessType>
            <Description>This node is a parent node to cover Microsoft extensions.</Description>
            <DFFormat>
              <node />
            </DFFormat>
            <Occurrence>
              <One />
            </Occurrence>
            <Scope>
              <Dynamic />
            </Scope>
            <DFType>
              <DDFName></DDFName>
            </DFType>
            <MSFT:RWAccess>1</MSFT:RWAccess>
          </DFProperties>
          <Node>
            <NodeName>RemoveOptions</NodeName>
            <DFProperties>
              <AccessType>
                <Add />
                <Get />
              </AccessType>
              <Description>This node specifies the nature of a removal operation, such as required, optional, silent, and so on The only valid value is Silent.</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>CabHash</NodeName>
            <DFProperties>
              <AccessType>
                <Get />
              </AccessType>
              <Description>This node provides the SHA1 hash of the cab file where the application is installed from.</Description>
              <DFFormat>
                <chr />
              </DFFormat>
              <Occurrence>
                <One />
              </Occurrence>
              <Scope>
                <Dynamic />
              </Scope>
              <DFType>
                <MIME>text/plain</MIME>
              </DFType>
              <MSFT:RWAccess>1</MSFT:RWAccess>
            </DFProperties>
          </Node>
        </Node>
      </Node>
    </Node>
    </Node>
  </Node>
</MgmtTree>

See Also

Reference

Inventory Configuration Service Provider