Provisioning XML Document for Install Configuration Service Provider (Compact 2013)

  • Article

3/26/2014

Configuration Manager uses this XML document to change settings on a Windows Embedded Compact powered device during an installation.

Syntax

<wap-provisioningdoc>
   <characteristic type="Install">
     <parm name="<ParmName>" value="<ParmValue>" />
   </characteristic>
</wap-provisioningdoc>

Elements

Element name

Description

Attribute

characteristic

Groups settings for a configuration service provider.
type

Set to "Install" to indicate the root characteristic element for the Install configuration service provider.

parm

Metadata that describes a device setting.
name

The name of the device setting to configure. It can be one of the following:

ValueDescription
InstallPhaseThe installation phase. When used, the corresponding value attribute must be set to "install."
SetupDLLThe name of the setup DLL.
AppNameThe application name. When used, the corresponding value attribute is the name of the application that was specified in the .inf file. Note   This string can have a maximum of 70 characters.
InstallDirThe name of the installation directory that was specified in the .inf file. You can also use the translation attribute in an InstallDir parm element.
NumDirsNumber of directories. When used, the corresponding value attribute indicates the number of directories to create. You define the directories to create in the FileOperation configuration service provider XML.
NumFilesNumber of files. When used, the corresponding value attribute indicates the number of files to install. You define the files to install in the FileOperation configuration service provider XML.
NumRegKeysNumber of registry keys. When used, the corresponding value attribute indicates the number of registry keys to install. You define registry keys to install in the Registry configuration service provider XML.
NumRegValuesNumber of registry entries. When used, the corresponding value attribute indicates the number of registry entries to install. You define registry entries in each key in the Registry configuration service provider XML.
NumShortcutsNumber of shortcuts. When used, the corresponding value attribute indicates the number of shortcuts to install. You define shortcuts in the FileOperation configuration service provider XML.
value

See descriptions in name attribute for possible values.

translation

The translation to perform. It can be one of the following values:

ValueDescription
filesystemRemoves double backslashes from file paths.
installIncludes all the translations done for "filesystem."

Remarks

You can use the CAB Wizard to compile an information (.inf) file into a cabinet (.cab) file that copies files and sets registry keys.

You can use the Wceload Tool to launch an application installation defined in a .cab file.

The .inf file also generates a provisioning XML file that is processed by the Install configuration service provider and also by the FileOperation and Registry configuration service providers. This XML file supports only a subset of elements and its own attribute values for the characteristic and parm elements.

For more information about elements, see Provisioning XML Document.

This XML document is located in _setup.xml in the .cab file on the device.

Example

The following example code configures device settings during an installation.

Important

For readability, the following code example does not contain security checking or error handling. Do not use the following code in a production environment.

<wap-provisioningdoc>
   <characteristic type="Install">
     <parm name="InstallPhase" value="install" />
     <parm name="SetupDLL" value="1" />
     <parm name="AppName" value="Microsoft setupdlltester" />
     <parm name="InstallDir" value="%CE1%" translation="install" />
     <parm name="NumDirs" value="2" />
     <parm name="NumFiles" value="2" />
     <parm name="NumRegKeys" value="1" />
     <parm name="NumRegVals" value="2" />
     <parm name="NumShortcuts" value="1" />
  </characteristic>
  <characteristic type="FileOperation">
      <characteristic type="%CE1%" translation="install">
        <characteristic type="MakeDir" />
        <characteristic type="setupdlltester.exe" translation="install">
          <characteristic type="Extract">
            <parm name="Source" value="SETUPD~1.001" />
          </characteristic>
        </characteristic>
        <characteristic type="setup.dll" translation="install">
        <characteristic type="Extract">
          <parm name="Source" value="000setup.002" />
        </characteristic>
     </characteristic>
    </characteristic>
    <characteristic type="%CE17%" translation="install">
      <characteristic type="MakeDir" />
      <characteristic type="setupdlltester.lnk" translation="install">
        <characteristic type="Shortcut">
          <parm name="Source" value="%CE1%\setupdlltester.exe" translation="install" />
        </characteristic>
      </characteristic>
    </characteristic>
 </characteristic>
 <characteristic type="Registry">
    <characteristic type="HKCU\Software\setupdlltester">
      <parm name="MajorVersion" value="1" datatype="integer" />
      <parm name="MinorVersion" value="0" datatype="integer" />
    </characteristic>
 </characteristic>

Requirements

sysgen

SYSGEN_DMSRV,
SYSGEN_SYSCSPS_INSTDLLCSP

See Also

Reference

Configuration Service Provider Reference
IConfigManager
Provisioning XML Document for Registry Configuration Service Provider
Provisioning XML Document for FileOperation Configuration Service Provider

Other Resources

CAB Wizard