Custom Template Database Fields

You can use the following field names within custom templates to retrieve information from a store's products and pages databases. You can use the IF tag to test whether a field has a value, such as:

[-- IF PAGE.DisplayName --]
<H1>[-- PAGE.Name --]</H1>
[-- END_IF --]

If a page or product does not have a value set for a field that is used in a template, the tag for that field will be replaced with an HTML comment tag similar to the following:

<!-- Empty field [Graphic] -->

Page Fields

Field Name
Description
Name
The name of the page, as entered in the Page Name field. Note that the page name is not the same as the pages's file name. Common places to use this field are in the <TITLE> and as the highest level heading on the page.
DisplayName
Returns checked if the page name is to be displayed. Use an IF statement to determine the value:

[-- IF PAGE.DisplayName --]
<H1>[-- PAGE.Name --]</H1>
[-- END_IF --]

Graphic
Returns a full <img src> tag with all the formatting information, including size and alt values.
DisplayGraphic
Returns checked if the page graphic is to be displayed. Use an IF statement to determine the value:

[-- IF PAGE.DisplayGraphic --]
<P>[-- PAGE.Graphic --]</P>
[-- END_IF --]

Text1
The contents of the Text 1 field for the page.

Note: Although merchants can put HTML tags in most fields to format their contents, the Text fields are most likely to contain extensive HTML tags, including tables, lists, and even <IMG SRC> tags.

Text2
The contents of the Text 2 field for the page. See the note for the Text1 field.
Text3
The contents of the Text 3 field for the page. See the note for the Text1 field.
LinkName
The name that is to be used on other pages as a link to the current page. Use this tag between the [--DEFINE LINK_TO_PAGE--] and [--END_DEFINE LINK_TO_PAGE--] tags.
LinkGraphic
Returns a full <img src> tag with all the formatting information, including size and alt values, of the graphic that is to be used on other pages as a link to the current page. Use this tag between the [--DEFINE LINK_TO_PAGE--] and [--END_DEFINE LINK_TO_PAGE--] tags.
LinkText
Additional text that appears on other pages with links to the current page. Use this tag between the [--DEFINE LINK_TO_PAGE--] and [--END_DEFINE LINK_TO_PAGE--] tags.
TextWrap
Returns "on" if link text is to wrap under the link graphic, and "off" if the text is to appear beside the graphic. Use this tag between the [--DEFINE LINK_TO_PAGE--] and [--END_DEFINE LINK_TO_PAGE--] tags.
Layout
Returns the alignment to be applied to products and page links on the page. Possible values are:
  • Left aligned
  • Right aligned
  • Staggered; Start left
  • Staggered; start right
  • Centered

Columns
Returns the number of columns to be used to format products and page links on the page. Possible values are:
  • One column
  • Two columns
  • Three columns
  • Four columns
  • Five columns

DisplayColumnBorders
Returns checked if column borders are to be displayed.
PageWidth
Returns a string indicating the percentage of the page width that is to be used to display information. Possible values are:
  • 100%
  • 90%
  • 85%
  • 75%
  • 65%
  • 50%
DisplayPageHeader
Returns checked if the store's page header is to be displayed. Use an IF statement to determine the value:

[-- IF PAGE.DisplayPageHeader --]
<P>[-- HEADER --]</P>
[-- END_IF --]

DisplayPageFooter
Returns checked if the store's page footer is to be displayed. Use an IF statement to determine the value:

[-- IF PAGE.DisplayPageFooter --]
<P>[-- FOOTER --]</P>
[-- END_IF --]

TextColor
Returns the hex value of the text color for the page, preceded by a pound sign (#), such as #CC3333.
BackgroundColor
Returns the hex value of the background color for the page, preceded by a pound sign (#), such as #CC3333.
LinkColor
Returns the hex value of the color for links on the page, preceded by a pound sign (#), such as #CC3333.
VisitedLinkColor
Returns the hex value of the color for visited links on the page, preceded by a pound sign (#), such as #CC3333.
ActiveLinkColor
Returns the hex value of the color of links on the page at the moment they are clicked, preceded by a pound sign (#), such as #CC3333.
BackgroundImage
If a graphic is defined as a background image for the page, returns the full URL of that image.
Filename
The file name of the page. If the merchant left this field blank, the default file name is returned, such as Page1.html.
MetaKeywords
The list of words to put in the META NAME="keywords" tag in the HEAD section of the page.
MetaDescription
The text to put in the META NAME="description" tag in the HEAD section of the page.
SearchProductField
Returns checked if a product search box is to be displayed on this page. Use an IF statement to determine the value:

[-- IF PAGE.SearchProductField--]
<p>[-- SEARCH_FORM --]</p>
[-- END_IF --]

IndexedForSearch
Returns checked if the products on this page are to be indexed for search.

Product Fields

Field Name
Description
Name
The product name.
Price
The price of the product. Note that this value is formatted according to the store currency setting and includes the currency symbol.
AltPrice
The price of the product in the store's alternate currency, if an alternate currency has been defined. Note that this value is formatted according to the store currency setting and includes the currency symbol. If an alternate currency has not been defined for the store, this field returns an empty string.
SaleAmount
The sale price of the product. This is either a numeric value without a currency symbol, or a percent to be deducted from the Price, such as 10%.
AltSaleAmount
The sale price of the product in the store's alternate currency, if an alternate currency has been defined. This is either a numeric value without a currency symbol, or a percent to be deducted from the Price, such as 10%. If an alternate currency has not been defined for the store, this field returns an empty string.
Taxable
Returns checked if the current product is taxable.
TaxWareCode
The TaxWare code to be used in computing tax for the current product.
VAT
The VAT (Value Added Tax) rate to be charged for the current product.
Weight
The shipping weight of the current product. Used for weight-based shipping.
DimensionOptions
DimensionText
DimensionSelected
ExtraHandlingCharge
A handling charge to be applied when this product is ordered.
ShippingCharge
The charge for shipping the current product. Used for flat-rate shipping.
GroundShipping1
The charge to ship the current product by standard ground shipping.
SecondDayShipping1
The charge to ship the current product by second-day air shipping.
NextDayShipping1
The charge to ship the current product by next-day air shipping.
Shipping31
Shipping4
Shipping5
Shipping6
Shipping7
Shipping8
Shipping9
The charge to ship the current product via a merchant-defined method.
SKU
The SKU (stock code) of the current product.
Graphic
Returns a full <img src> tag for the product graphic with all the formatting information, including size and alt values.
ProductDescription
The text description of the current product. This field may contain HTML tags.
QuantityOnHand
Returns a numeric value for the quantity of the product considered to be in stock. Once the merchant sets this number, ShopSite decrements it for each product ordered.
LowStockThreshold
Returns a numeric value for the number of units at which ShopSite is to send an e-mail "low stock" notice to the merchant.
OutOfStockLimit
Returns a numeric value for the number of units remaining (QuantityOnHand) at which ShopSite is to stop taking orders for this product.
NoShippingCharges
Returns checked if the merchant marked this product for no shipping charges.
SearchKeywords
Returns the list of keywords that the merchant entered for search indexing.
OptionText
The text instructions given to customers to select product options from drop-down lists on the order form.
OptionFiniteText
Product options to be presented in drop-down lists on the order form. The options are returned as a single space-separated string; you will probably need to write a small program and use the CALL tag to process it. For ShopSite Pro stores, the selected options can change the price of the product.
DisplayOrderingOptions
Returns checked if the product's ordering options are to be displayed on the product page as well as on shopping cart. Use an IF statement to determine the value:

[--IF PRODUCT.DisplayOrderingOptions--]
some tags
[--END_IF--]

OptionsBox
Returns checked if a customer text entry box for this product is to be displayed on the order form.
DisplayMoreInformationPage
Returns checked if there is a More Information Page defined for this product.
MoreInformationText
The product description to display on the More Information Page for the current product.
MoreInformationGraphic
Returns a full <img src> tag for the graphic for the product More Information Page, with all the formatting information, including size and alt values.
MoreInformationFileName
The file name of the More Information Page for the current product. If the merchant left this field blank, ShopSite assigns a file name and returns that value, such as Product1.html.
DisplayName
Returns checked if the product name is to be displayed.
DisplaySKU
Returns checked if the product SKU is to be displayed.
DisplayPrice
Returns checked if the product price is to be displayed.
DisplayGraphic
Returns checked if the product graphic is to be displayed.
SaleOn
Returns checked if the sale price is to be displayed and if the SaleAmount field is not null, that is, if the product is on sale.
NameStyle
Returns Bold, Italic, Typewriter, or Plain to indicate the font style to use for the product name.
NameSize
Returns Normal, Big, or Small to indicate the font size to be used for the product name.
PriceStyle
Returns Bold, Italic, Typewriter, or Plain to indicate the font style to use for the product price.
PriceSize
Returns Normal, Big, or Small to indicate the font size to be used for the product price.
SKUStyle
Returns Bold, Italic, Typewriter, or Plain to indicate the font style to use for the product SKU.
SKUSize
Returns Normal, Big, or Small to indicate the font size to be used for the product SKU.
DescriptionStyle
Returns Bold, Italic, Typewriter, or Plain to indicate the font style to use for the product description.
DescriptionSize
Returns Normal, Big, or Small to indicate the font size to be used for the product description.
ImageAlignment
Returns left, right, or center to indicate if the product image is to be aligned to the left, right, or center.
TextWrap
Returns On if the product description is to wrap under the product graphic, and Off if the description is to maintain a column to the side of the graphic.
AddToCartButton
Returns the text to use for the [Add to Cart] button. This may be just simple text, or text with HTML tags to format the text, or an <img> tag.

Note that custom templates do not support the image selection drop-down list introduced in version 5.0. You must either use a text button, or specify the path to a graphic file.

ViewCartButton
Returns the text to use for the [View Cart] button. This may be just simple text, or text with HTML tags to format the text, or an <img> tag.

Note that custom templates do not support the image selection drop-down list introduced in version 5.0. You must either use a text button, or specify the path to a graphic file.

OrderCheckout
Returns a complete set of FORM tags to present the [Add to Cart] and [View Cart] buttons, as defined for the product. If the product has the display of ordering options and/or quantity enabled, they are included as parts of the form.
Field1
Field2
Field3
Field4
Field5
Generic string fields that the merchant can use to enter product information that does not fit in any of the predefined fields.
subproduct
Returns a comma-separated list of the record numbers of any subproducts assigned to the current product. Use with an IF tag to see if any subproducts exist for the current product.

Unsupported Fields

The following page and product fields cannot be used in templates.

Page Fields:

Link Location
Template
Order
Products Sort Field
Pages Sort Field
Products First

Product Fields:

In These Pages
Template


1 Merchants can change the names and purposes of all shipping methods, but templates must use these default fields names. That means that, for example, a template might contain the [-- PRODUCT.SecondDayShipping --] tag, but the merchant may have redefined that shipping method to "Overnight, morning delivery."


ShopSite Help and Resource Center
August 15, 2002
Give Feedback

Copyright © ShopSite, Inc.
http://www.shopsite.com