User Tools

Site Tools


Package Manifest

This page is a WIP. There is likely to be incomplete and or missing information while the page is being built.

Summary

The Package Manifest is the file that resides within the package and provides information used by Install Manager to perform the installation.

Detail

The Package Manifest is an XML file, named “Manifest.dsx,” which resides within the root directory of a package. This file provides information through pre-defined elements, attributes, and values that are used by Install Manager to perform the installation.

Example

<DAZInstallManifest VERSION="0.1">
 <GlobalID VALUE="efed632b-f748-4c10-b467-d43fadb8d82e"/>
 <!-- File, Application, Desktop, AppMenu Elements -->
</DAZInstallManifest>

Elements & Attributes

  • DAZInstallManifest - This element is expected at the root of the document. It identifies the contents of the file as being one which provides installation information about a product to Install Manager.
    • VERSION - The version number of the structure and formatting of the file — i.e., 0.1.
  • GlobalID - This element is expected as a child to the root element.
    • VALUE - Defines a Globally Unique Identifier (GUID), which is used to uniquely and globally identify the product within the ecosystem.
      • Consists of 32 Hexadecimal digits grouped in sets of 8, 4, 4, 4, and 12.
        • Each set of characters is separated by a single hyphen.
  • File - This element is expected as a child to the root element. It provides installation information relating to a file contained within the package.
    • TARGET - A string representing the type of base path for the file.
      • Application - See TYPE, VERSION, PLATFORM, BITARCH and VALUE.
      • Content -
      • Temp -
    • TYPE - …
      • DAZ Studio -
    • VERSION - A string representing the version of the application specified in TYPE.
    • PLATFORM - A string representing the computing platform.
      • PC - The Windows operating system.
      • Mac - The OS X operating system.
    • BITARCH - A string representing the bit-architecture of the target installation. If specified, the file represented by the element is extracted during installation.
      • 32 -
      • 64 -
    • ACTION - …
      • Install -
      • SetVariable - See VARIABLE and VALUE.
      • Execute - See EXECUTEONUNINSTALL, EXECUTEONINSTALL, and EXECUTEELEVATED.
    • EXECUTEONUNINSTALL - A boolean value indicating whether or not to execute during uninstall.
      • True
      • False
    • EXECUTEONINSTALL - A boolean value indicating whether or not to execute during install.
      • True
      • False
    • EXECUTEELEVATED - A boolean value indicating whether or not the command should request elevated permissions in order to execute.
      • True
      • False
    • VARIABLE - The name of a variable to set.
    • VALUE - …
  • Application - This element is expected as a child to the root element. It provides installation information relating to an application that is provided by the package. This element causes an entry to be created in the list of Applications that Install Manager knows about.
    • TYPE - …
      • DAZ Studio -
    • VERSION - A string representing the version of the application specified in TYPE.
    • PLATFORM - A string representing the computing platform.
      • PC - The Windows operating system.
      • Mac - The OS X operating system.
    • BITARCH - A string representing the bit-architecture of the target installation. If specified, the file represented by the element is extracted during installation.
      • 32
      • 64
    • VALUE - The path to the application folder.
  • Desktop - This element is expected as a child to the root element. It provides the installation information required to create a shortcut on the desktop (if the option is enabled and selected).
    • TARGET - …
    • TYPE - …
      • DAZ Studio -
    • VERSION - A string representing the version of the application specified in TYPE.
    • PLATFORM - A string representing the computing platform.
      • PC - The Windows operating system.
      • Mac - The OS X operating system.
    • BITARCH - A string representing the bit-architecture of the target installation. If specified, the file represented by the element is extracted during installation.
      • 32
      • 64
    • ACTION - …
      • Install
    • VALUE - The slash delimited path (folder hierarchy and name) of the desktop shortcut to create.
    • PATH - The path to the file within the archive that the shortcut links to.
  • AppMenu - This element is expected as a child to the root element. It provides the installation information required to create a shortcut in the application menu, i.e., the Start Menu on Windows (if the option is enabled and selected).
    • TARGET - …
    • TYPE - …
      • DAZ Studio -
    • VERSION - A string representing the version of the application specified in TYPE.
    • PLATFORM - A string representing the computing platform.
      • PC - The Windows operating system.
      • Mac - The OS X operating system.
    • BITARCH - A string representing the bit-architecture of the target installation. If specified, the file represented by the element is extracted during installation.
      • 32
      • 64
    • ACTION - …
      • Install
    • VALUE - The slash delimited path (folder hierarchy and name) of the application menu shortcut to create.
    • PATH - The path to the file within the archive that the shortcut links to.