Package Supplement File

2020-03-25T21:06:39+00:00

Package Supplement File

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

Summary

A Package Supplement File, as the name suggests, is a file that provides supplemental information about an Install Manager compatible package. The supplemental information contained within the file is required by the application so that it can display certain information and perform various tasks.

Detail

A Package Supplement File is automatically created upon completing the download of a package through Install Manager. The information contained within this file is derived from product and account history data, retrieved from the Daz 3D store when you log into your account from within Install Manager.

Adjacent

As packages can be downloaded manually outside of Install Manager, and/or originate from sources other than Daz 3D, and then be placed in the “Package Archive” folder specified in the application settings, Install Manager will generate a Package Supplement File for each package that follows the Package Naming guidelines and doesn't already have one.

Embedded

If the package contains a “Supplement.dsx” file in the root of the package, Install Manager will parse a subset of the information described below to produce a Package Supplement File next to the package.

Fallback

If the package does not contain the expected file in the expected location, or if the file cannot be successfully parsed, Install Manager will generate the Package Supplement File from the name and bytes of the package itself.

Example

Click the name of the example below to save it as a file.

IM00016280-01_Genesis2FemaleStarterEssentials.dsx

<?xml version="1.0" encoding="UTF-8"?>
<ProductSupplement VERSION="0.1">
	<ProductName VALUE="Genesis 2 Female Starter Essentials"/>
	<ProductStoreIDX VALUE="16280-1"/>
	<UserOrderDate VALUE="2013-05-03T18:51:15Z"/>
	<InstallerDate VALUE="2013-07-01T20:04:05Z"/>
	<ProductFileGuid VALUE="8c843235-46af-8eef-eb28-41094d9d57c9"/>
	<ProductTags VALUE="DAZStudio4_5,DSON_Poser"/>
</ProductSupplement>

Elements & Attributes

ProductSupplement - An enclosing element that identifies the contents of the file as being one which provides supplemental information about a product to Install Manager.
- This element is expected to exist in an adjacent dsx
- This element is expected to exist in an embedded Supplement.dsx

ProductName - The name displayed to the user within the Install Manager User Interface (UI).
- This element is expected to exist in an adjacent dsx
- This element is expected to exist in an embedded Supplement.dsx

ProductStoreIDX - A hyphenated value, comprised of two integers, that is used to uniquely identify the product and package within a given source. The left portion of the value corresponds with the Stock Keeping Unit (SKU) used to identify the product, while the right portion of the value is used to uniquely identify the package within the product. The left portion of the value should be greater than 0 and should not exceed 99,999,999. The exception to this being packages from 3rd party sources, in which case the Source Prefix for the package is encoded. The right portion of the value should be greater than 0 and should not exceed the number 99.
- This element is expected to exist in an adjacent dsx
- This element is expected to exist in an embedded Supplement.dsx

UserOrderDate - The UTC datetime that the package was added to the current account, in ISO 8601 extended format. This datetime can be used to sort product lists displayed in the Install Manager UI.
- This element is expected to exist in an adjacent dsx
- This element is ignored if it exists in an embedded Supplement.dsx

InstallerDate - The UTC datetime of the package itself, in ISO 8601 extended format. This datetime can be used to sort product lists displayed in the Install Manager UI by their respective package dates.
- This element is expected to exist in an adjacent dsx
- This element is ignored if it exists in an embedded Supplement.dsx

ProductFileGuid - A Globally Unique Identifier (GUID) created from a MD5 digest of the associated package. This GUID is used to determine whether the associated package is an update for a product/package that is already installed, as well as whether an update for the product/package exists on the Daz 3D store.
- This element is expected to exist in an adjacent dsx
- This element is ignored if it exists in an embedded Supplement.dsx

InstallTypes - A comma delimited list of predefined Types that have been assigned to the package and describe the manner in which files are installed.
- This element is expected to exist in an adjacent dsx
- This element is expected to exist in an embedded Supplement.dsx

ProductTags - A comma delimited list of predefined Tags that have been assigned to the package and describe the association of files in the package.
- This element is expected to exist in an adjacent dsx
- This element is expected to exist in an embedded Supplement.dsx

Predefined Types

Software
Plugin
Content

Predefined Tags

Tags are used to associate a package with an intended application [or major version of application], so that when a user sets their preference for which application(s) they wish to see downloads for, they only see the downloads that are intended to work with the application(s) they choose. In some cases, one package is intended to be used with multiple applications and will be assigned multiple tags, while in other cases the intent can be for one package to be used for only one application and will be assigned a single tag.

The tags that are assigned to a package can be dynamic. As products are updated over time (i.e. a new version specific package becomes available and supersedes an older version), the tags that are assigned to them can sometimes change.

The tables below list all of the predefined tags that are currently supported by Install Manager:

The Label column lists the text displayed within the User Interface (UI) in places like tool tips for the Ready to Download Page, Ready to Install Page and Installed Page, as well as being options on the download_page in the Settings Window.
The Value column lists the corresponding strings used internally by the application and in various resources like a Package Supplement File and a Package Manifest.

Application Tags

The tags listed here are those that associate a given package with an application.

Label	Value
3ds Max	3dsMax
Blender	Blender
Bryce	Bryce
Carrara 8.5	Carrara8_5
Carrara 8	Carrara8
Carrara 7.2	Carrara7_2
Carrara 7	Carrara7
Carrara (< 7)	CarraraLegacy
Cinema 4D	Cinema4D
DAZ Studio 5	DAZStudio5
DAZ Studio 4.5+	DAZStudio4_5
DAZ Studio 4	DAZStudio4
DAZ Studio 3	DAZStudio3
DAZ Studio (< 3)	DAZStudioLegacy
DSON Importer for Poser	DSON_Poser
Hexagon	Hexagon
Install Manager	InstallManager
LightWave 3D	Lightwave
Maya	Maya
Photoshop	Photoshop
Poser 9+	Poser9
Poser (< 9)	PoserLegacy
Unity	Unity
Unreal	Unreal
Vue	Vue
General	General

Install Type Tags

The tags listed here are those that describe how (and to some degree where) the contents of a given package is installed - “like software” or “like a plugin.” The lack of one of these tags on a package implies that its contents installs “like content” to the currently selected content install path. Note that the presence of one (or both) of these tags does preclude the package from also containing files that install “like content.”

Label	Value
Software	Software
Plugin	Plugin

Platform Tags

The tags listed here are those that associate a given package with a particular platform and bit architecture. The lack of one of these tags on a package implies that its contents is not specific to a particular platform. Note that the presence or lack of one (or multiple) of these tags does preclude the package from containing files that only install on a given platform and/or given bit architecture.

Label	Value
Windows 32-bit	Win32
Windows 64-bit	Win64
Mac 32-bit	Mac32
Mac 64-bit	Mac64

Release Channel Tags

The tags listed here are those that associate a given package with a particular release channel. The lack of one of these tags on a package implies that the package is associated with the General Release channel.

Label	Value
Public Build	PublicBuild
Publishing Build	PublishingBuild
Private Build	PrivateBuild

Daz Connect Tags

The tags listed here are those that are specific to the Daz Connect service.

Label	Value
Connect Available	CloudAvailable
Connect Installed	CloudInstalled

Documentation Center public:software:install_manager:referenceguide:tech_articles:package_supplement_file

Package Supplement File

Package Supplement File

Summary

Detail

Adjacent

Embedded

Fallback

Example

Elements & Attributes

Predefined Types

Predefined Tags

Application Tags

Install Type Tags

Platform Tags

Release Channel Tags

Daz Connect Tags