Home >	Contents >	Index >

AssetMaker   |    Cart Tags   |    Errors   |    Miscellany   |    Index

ASSET

The first tag in an asset descriptor file.

It names the new asset type and its database table and sets some behavior and display attributes of the assets of that type. The opening tag, <ASSET>, is always the first line of code in an asset descriptor file and the closing tag, </ASSET>, is always the last line of code.

There can be only one ASSET tag pair per asset descriptor file because you can create only one asset type per asset descriptor file.

Syntax

<ASSET 
NAME="assetTypeName" 
DESCRIPTION="assetTypeName" 
[PLURAL="plural form"]
PROCESSOR= "6.0" 
[MARKERTEXT="*"]
[MARKERIMAGE="pathfileforimage"] 
DEFDIR= "directoryname">
[RENDERUSINGTEMPLATE="yes|no"]
[UNNAMEDASSOCIATIONS="yes|no"]
</ASSET>

Parameters

NAME (required)

The internal name of the asset type. AssetMaker uses this string for the following items:

• As the name of the database table for assets of this type.
• As the name of the folder in the ElementCatalog table that holds the elements that AssetMaker creates to format the CS-Direct forms for working with assets of this type.

Because the string provided by this parameter becomes the name of the database table, you must use only the characters that your DBMS recognizes.

DESCRIPTION (required)

The external name of this asset type, that is, the name of this asset type when it is displayed in the CS-Direct forms and menus.

PLURAL (optional)

The external name of the plural form of the asset type, that is, the name of this asset type when it is displayed in the CS-Direct forms and menus. If not provided the plural form is created by adding 's' to the value provided in the DESCRIPTION field. This value can subsequently edited via the Admin UI.

PROCESSOR (required)

The version number of AssetMaker at the time that you upload this asset descriptor file. The current version number is 6.

Earlier versions are used for asset types created in previous versions. The version number must be the same as the version of Content Server when the asset type was created.

MARKERTEXT (optional)

A string of up to 32 characters that marks required fields for this asset type in the CS-Direct forms. (Fields are defined as required with the INPUTFORM attributes. See INPUTFORM for more information.) You can use a text string only; you cannot use HTML or any other markup code in the string for MARKERTEXT.

This parameter is used in conjunction with the MARKERIMAGE argument, described next. If both MARKERTEXT and MARKERIMAGE are set, only the image specified by MARKERIMAGE is used in the CS-Direct forms.

If a field is defined as required but there is no value set for either MARKERTEXT or MARKERIMAGE, AssetMaker uses an asterisk (*) to mark the field as required.

MARKERIMAGE (optional)

An image file to use to mark required fields in the CS-Direct forms for assets of this type. The string defined for MARKERIMAGE must be a URL that refers to a .gif or a .jpg image file. The URL must point to a valid Web root directory that is configured on the Web server or to a directory relative to that root.

DEFDIR (required)

The default storage directory for column data that is to be stored as an external file. In other words, the storage directory for any upload fields (URL column, URL field) in the asset type. All asset types must have DEFDIR defined.

For information about upload fields, see INPUTFORM.

RENDERUSINGTEMPLATE (optional)

Indicates whether this asset type can be previewed using a Template asset. If not provided, it is set to yes. When set to no, the preview icon will not appear for assets of this type.

UNNAMEDASSOCIATIONS (optional)

Indicates whether this asset type is a heterogenous collection assets, i.e., can have multiple children assets of multiple asset types. When this is set to 'yes', the edit form for this asset type will include a select box for selecting assets into the asset. If not provided, it is set to 'no'.

Example

This code fragment shows the ASSET statement for an asset type named ImageFile:

<ASSET NAME="ImageFile" DESCRIPTION="ImageFile" 
MARKERIMAGE="/Xcelerate/data/required.gif" PROCESSOR="6.0" DEFDIR="c:/Fatwire/Storage/ImageFile">

This code fragment shows the ASSET statement for an asset type named Container that supports unnamed associations:

<ASSET NAME="Container" DESCRIPTION="Container" PLURAL="Containers" UNNAMEDASSOCIATIONS="YES" 
DEFDIR="C:/Fatwire/Storage/Container" MARKERTEXT="*">

This code fragment shows the ASSET statement for an asset type named StyleSheet that is not rendered via Template asset:

<ASSET NAME="StyleSheet" DESCRIPTION="Style Sheet" PLURAL="Style Sheets" PROCESSOR="6.0" 
DEFDIR="c:FatwireStorageStyleSheet" RENDERUSINGTEMPLATE="no">

		Home >	Contents >	Index >
	FatWire Miscellaneous Reference Copyright 2005,2006,2007 by FatWire Software All rights reserved.