Metadata Support File (WIP)

2023-10-19T03:43:09+00:00

Metadata Support File (WIP)

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

Summary

A Metadata Support File is a file that provides product and/or asset information used by Daz Studio to control how and where a file is presented to the user.

Detail

A Metadata Support File is an XML file which typically resides within the Content/Runtime/Support directory of a package, or the ./Runtime/Support directory within a mapped content directory. This file provides product and/or asset information used by Daz Studio to control how and where a file is presented to the user.

Example

<ContentDBInstall VERSION="1.0" >
	<Products>
	    <Product VALUE="Product Name" >
	        <StoreID VALUE="StoreID" />
	        <GlobalID VALUE="00000000-0000-0000-0000-000000000000" />
	        <ProductToken VALUE="12345" />
	        <Description><![CDATA[description text goes here]]></Description>
	        <Artists>
	            <Artist VALUE="Artist Name" />
	        </Artists>
	        <Assets>
	            <Asset VALUE="/Relative/Path/To/SomeUserFacingFile.ext" >
	                <Description><![CDATA[description text goes here]]></Description>
	                <ContentType VALUE="/Path/of/Content/Type" />
	                <Audience VALUE="Teens" />
	                <Categories>
	                    <Category VALUE="/Path/of/Category" />
	                </Categories>
	                <Compatibilities>
	                    <Compatibility VALUE="/Path/to/Compatibility/Base" />
	                </Compatibilities>
	                <CompatibilityBase VALUE="/Path/of/Compatibility/Base" />
	                <Tags>
	                    <Tag VALUE="keyword" />
	                    <Tag VALUE="ArtistName" />
	                </Tags>
	                <Userwords>
	                    <Userword VALUE="keyword" />
	                </Userwords>
	                <UserNotes><![CDATA[notes text goes here]]></UserNotes>
	            </Asset>
	        </Assets>
	        <SupportAssets VALUE="/Runtime/Support/ProductName.dsx">
	            <SupportAsset VALUE="/Relative/Path/To/SomeNonUserFacingFile.ext" />
	        </SupportAssets>
	        <ObjectCompatibilities>
	            <ObjectCompatibility VALUE="URI" REF="/Path/of/Object/SceneId" />
	        </ObjectCompatibilities>
	    </Product>
	</Products>
</ContentDBInstall>

Elements & Attributes

ContentDBInstall - This element is expected at the root of the document. It identifies the contents of the file as being one which provides information about a product to Daz Studio.
- VERSION - The version number of the structure and formatting of the file—i.e., 1.0.
- This element is required.

Products - This element is expected as a child of the ContentDBInstall element.
- Encapsulates a list of one or more individual products.
- This element is required.

Product - This element is expected as a child of the Products element.
- Each product represents a specific collection of files.
- This element is required per unique product.

StoreID - This element is expected as a child of a Product element.
- VALUE - Defines the sequence of characters that identify the source (store) for the product.
  - The value specified must exist in the content database before the metadata in the encompassing product is imported/installed; see the Add Store Id scripting sample.
    - If the value specified does not exist in the database prior to importing/installing the data, the data is associated with the “LOCAL USER” store instead.
  - The “DAZ 3D” identifier is reserved for use by Daz 3D proper.
- This element is optional.
  - If this element is missing, the “LOCAL USER” store is assumed.

GlobalID - This element is expected as a child of a Product 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.
  - Once a GUID has been assigned to a product, that product should maintain that GUID throughout its entire life cycle.
  - The value 00000000-0000-0000-0000-000000000000 is reserved for “User Data.”
- This element is optional.
  - If this element is missing or invalid, the “LOCAL USER” product is assumed.

ProductToken - This element is expected as a child of a Product element.
- VALUE - Defines the identifier used by the store (defined in StoreID) to identify the product.
  - This value is used for local relational queries, and for constructing the URL for the product; see DzProductAssetContainer::getURL().
- This element is optional.

Description - This element is expected as a child of a Product element, or an Asset element.
- CDATA - This value is used to display a message about the Product or Asset to the end user of the application.
- This element is optional.

Artists - This element is expected as a child of a Product element. It encapsulates a list of one or more individual contributing artist names.
- This element is optional.

Artist - This element is expected as a child of an Artists element.
- VALUE - The name of the contributing artist.
- This element is optional.

Assets - This element is expected as a child of a Product element. It encapsulates a list of one or more individual user-facing assets.

Asset - This element is expected as a child of an Assets element.
- VALUE - The relative path of any user-facing file.
  - The value specified is expected to be relative to any mapped base content directory.
- This element is required per user-facing file.

ContentType - This element is expected as a child of an Assets element.
- VALUE - Specifies a value from Content Types.
- This element is optional.

Audience - This element is expected as a child of an Assets element.
- VALUE - Asset classification for the intended audience (i.e. Children/Teens/Adults)
- This element is optional.
  - If this element is missing, the highest audience is assumed.

Categories - This element is expected as a child of an Asset element. It encapsulates a list of one or more individual categories.

Category - This element is expected as a child of a Categories element.
- VALUE - The relative (to root) category path.
  - Consists of a slash (“/”) delimited hierarchical string used for progressive filtering.
- See Default Categories.
- This element is optional.

Compatibilities - This element is expected as a child of an Asset element. It encapsulates a list of one or more individual compatibilities.
- This element is optional.

Compatibility - This element is expected as a child of a Compatibilities element.
- VALUE - Specifies a CompatibilityBase for an asset that this asset is compatible with.
  - Consists of a slash (“/”) delimited hierarchical string used for progressive filtering.
    - A “#” can be used in place of the last “/” followed by trailing text to denote use of an additional filter.
  - This element is optional.

CompatibilityBase - This element is expected as a child of an Assets element.
- VALUE - Specifies the CompatibilityBase for this asset, and allows other assets to indicate compatibility with this asset.
  - Consists of a slash (“/”) delimited hierarchical string used for progressive filtering.
    - A “#” can be used in place of the last “/” followed by trailing text to denote use of an additional filter.
  - This element is optional.

Tags - This element is expected as a child of an Asset element. It encapsulates a list of one or more individual keywords.
- This element is optional.

Tag - This element is expected as a child of a Tags element.
- VALUE -
- This element is optional.

Userwords - This element is expected as a child of an Asset element. It encapsulates a list of one or more individual user keywords.
- This element is optional.

Userword - This element is expected as a child of a Userwords element.
- VALUE -
- This element is optional.

UserNotes - This element is expected as a child of an Assets element.
- CDATA -
- This element is optional.

SupportAssets - This element is expected as a child of a Product element. It encapsulates a list of one or more individual support assets.
- VALUE - The relative path of the file that contains this metadata information.

SupportAsset - This element is expected as a child of a SupportAssets element.
- VALUE - The relative path of any non-user-facing file.
  - The value specified is expected to be relative to any mapped base content directory.
- This element is optional.

ObjectCompatibilities - This element is expected as a child of a Product element. It encapsulates a list of one or more individual object compatibilities.

ObjectCompatibility - This element is expected as a child of an ObjectCompatibilities element.
- VALUE -
- REF -

Documentation Center public:software:dazstudio:4:referenceguide:tech_articles:metadata

Metadata Support File (WIP)

Metadata Support File (WIP)

Summary

Detail

Example

Elements & Attributes