Overview
| Excerpt |
|---|
Product Tokens are used in templates to display calculations from the business logic of Customer Self Service. |
| Wiki Markup |
|---|
||Token||Description||Type 1 Usage|Razor Usage||
|AccessoriesAvailable|WARNING: Uses LivePriceCache to get data not ProductAlternatives
Gets whether there are accessories available for this product for the
current user. Deals with non-contract/contract differences and uses the LivePriceCache
to determine the availability.|Product.AccessoriesAvailable|productAccessoriesAvailable|
|AccessoriesCount|WARNING: Reduced ProductAlternatives query and applies contract item rules
Gets whether there are Accessories available for this product|Product.AccessoriesCount|productAccessoriesCount|
|AddProductToComparisonListToken|Token that renders out rcAddProductToComparisonList resource and can be used in
CSSREPEATS for example. This token essentially sets up html for the
productCompareButton widget. It replaces {0} with the products product code and {1}
with the product description (quotes escaped to prevent breaking html)|Product.AddProductToComparisonListToken|productAddProductToComparisonListToken|
|AddReviewButton|TBA|Product.AddReviewButton|productAddReviewButton|
|AddToFavouritesButton|TBA|Product.AddToFavouritesButton|productAddToFavouritesButton|
|AddToOrCreateOwnRegistryListButton|Used to render a html button for the purpose of adding a Product to one of the user's own
Registry List or to Create and add to a new one.|Product.AddToOrCreateOwnRegistryListButton|productAddToOrCreateOwnRegistryListButton|
|AddToOrderButton|TBA|Product.AddToOrderButton|productAddToOrderButton|
|AllowOrderEntryForProduct|Gets whether the user should be permitted to order this product based on various
business rulesPrice LimitOrder Entry RestrictionsObsolete ProductsView Only CatalogueProducts not in warehouse|Product.AllowOrderEntryForProduct|productAllowOrderEntryForProduct|
|AlternatesAccessoriesText|Gets Html about accessories or products relating
to the product in question|Product.AlternatesAccessoriesText|productAlternatesAccessoriesText|
|AlternatesAvailable|WARNING: Uses LivePriceCache to get data not ProductAlternatives
Gets whether there are alternates available for this product for the
current user. Deals with non-contract/contract differences and uses the LivePriceCache
to determine the availability.|Product.AlternatesAvailable|productAlternatesAvailable|
|AlternatesCount|WARNING: Reduced ProductAlternatives query and applies contract item rules
Gets whether there are Alternates available for this product|Product.AlternatesCount|productAlternatesCount|
|AttributedProductDropDownList|TBA|Product.AttributedProductDropDownList|productAttributedProductDropDownList|
|AttributeList|Returns all productattributeproducts stored in the database|Product.AttributeList|productAttributeList|
|AttributePriceBreakContainer|TBA|Product.AttributePriceBreakContainer|productAttributePriceBreakContainer|
|AvailableForBot|TBA|Product.AvailableForBot|productAvailableForBot|
|AvailableForOne|TBA|Product.AvailableForOne|productAvailableForOne|
|AvailableQty|TBA|Product.AvailableQty|productAvailableQty|
|AvailableQtyNotIncCurrentLinesString|TBA|Product.AvailableQtyNotIncCurrentLinesString|productAvailableQtyNotIncCurrentLinesString|
|AverageRating|TBA|Product.AverageRating|productAverageRating|
|AverageRatingDescription|TBA|Product.AverageRatingDescription|productAverageRatingDescription|
|AverageRatingText|TBA|Product.AverageRatingText|productAverageRatingText|
|BonusStockForProductText|TBA|Product.BonusStockForProductText|productBonusStockForProductText|
|CompanionCount|CACHED: Cached at record level
Does a count of the companion products for this product|Product.CompanionCount|productCompanionCount|
|ConfigureKitButton|Token for use in templates that renders a resource based input button that allows user to configure kit options providing
this product is a kit master product and has either configurable or optional kit components and the functionality is in use.|Product.ConfigureKitButton|productConfigureKitButton|
|CostCentreCode|Returns the cost centre code control HTML if the product is allowed to be ordered, otherwise returns an empty string|Product.CostCentreCode|productCostCentreCode|
|CustomerFavouritesProductDisplayIcon|Checks if the current product is in the list of customer favourites. If so, returns a resource.|Product.CustomerFavouritesProductDisplayIcon|productCustomerFavouritesProductDisplayIcon|
|CustomerProductCode|Gets a the customer specific product code for this system product. The ProductCode
of this product is mapped to a customer specific one, so we try and show that.|Product.CustomerProductCode|productCustomerProductCode|
|DeleteFromUserStocktakeButton|TOKEN: Renders out a button that can be used to remove a product from the user's
current User Stocktake if it is on the stocktake...|Product.DeleteFromUserStocktakeButton|productDeleteFromUserStocktakeButton|
|DiscountForOne|TBA|Product.DiscountForOne|productDiscountForOne|
|DiscountForOneString|TBA|Product.DiscountForOneString|productDiscountForOneString|
|GPAmountEx|TBA|Product.GPAmountEx|productGPAmountEx|
|GPAmountExForQty(Decimal)|TBA|Product.GPAmountExForQty(Decimal)|productGPAmountExForQty(Decimal)|
|GPPercentageEx|TBA|Product.GPPercentageEx|productGPPercentageEx|
|GPPercentageExForQty(Decimal)|TBA|Product.GPPercentageExForQty(Decimal)|productGPPercentageExForQty(Decimal)|
|HasLiveQuantityBreaks|Gets whether the product has quantity breaks allowing for use in Xslt templates.
You could for example configure the display of template content if the current
product has live quantity breaks available, but otherwise not show the content.|Product.HasLiveQuantityBreaks|productHasLiveQuantityBreaks|
|ImagePrefix|TBA|Product.ImagePrefix|productImagePrefix|
|ImageSuffix|TBA|Product.ImageSuffix|productImageSuffix|
|IncTaxPrice|TBA|Product.IncTaxPrice|productIncTaxPrice|
|ItemCostEx|TBA|Product.ItemCostEx|productItemCostEx|
|ItemCostExForQty(Decimal)|TBA|Product.ItemCostExForQty(Decimal)|productItemCostExForQty(Decimal)|
|ItemsOnOrder|TBA|Product.ItemsOnOrder|productItemsOnOrder|
|KitCode|TOKEN: Get the Kit Code if configurable kits are enabled and this is a kit!|Product.KitCode|productKitCode|
|LiveQuantityBreakMessage|Gets a resource value for use in description to indicate quantity break pricing
applies to the particular product. Nothing will be returned if there are no
price break entries (i.e. HasLiveQuantityBreaks is false).|Product.LiveQuantityBreakMessage|productLiveQuantityBreakMessage|
|MetaDataSummary|Returns a summary of all product metadata as defined in MetaDataSummaryFieldGroup and
rendered using MetaDataSummaryTemplate from ProductCategory,Role or SystemControl|Product.MetaDataSummary|productMetaDataSummary|
|MetaDataSummaryCustom(String, String)|Returns a summary of all product metadata as defined in the supplied template and fieldgroup|Product.MetaDataSummaryCustom(String, String)|productMetaDataSummaryCustom(String, String)|
|NettPriceBreak0|Gets the Nett Quantity Price Break at level 0|Product.NettPriceBreak0|productNettPriceBreak0|
|NettPriceBreak0ExGST|TBA|Product.NettPriceBreak0ExGST|productNettPriceBreak0ExGST|
|NettPriceBreak0IncGST|TBA|Product.NettPriceBreak0IncGST|productNettPriceBreak0IncGST|
|NettPriceBreak1|Gets the Nett Quantity Price Break at level 1|Product.NettPriceBreak1|productNettPriceBreak1|
|NettPriceBreak1ExGST|TBA|Product.NettPriceBreak1ExGST|productNettPriceBreak1ExGST|
|NettPriceBreak1IncGST|TBA|Product.NettPriceBreak1IncGST|productNettPriceBreak1IncGST|
|NettPriceBreak2|Gets the Nett Quantity Price Break at level 2|Product.NettPriceBreak2|productNettPriceBreak2|
|NettPriceBreak2ExGST|TBA|Product.NettPriceBreak2ExGST|productNettPriceBreak2ExGST|
|NettPriceBreak2IncGST|TBA|Product.NettPriceBreak2IncGST|productNettPriceBreak2IncGST|
|NettPriceBreak3|Gets the Nett Quantity Price Break at level 3|Product.NettPriceBreak3|productNettPriceBreak3|
|NettPriceBreak3ExGST|TBA|Product.NettPriceBreak3ExGST|productNettPriceBreak3ExGST|
|NettPriceBreak3IncGST|TBA|Product.NettPriceBreak3IncGST|productNettPriceBreak3IncGST|
|NettPriceBreak4|Gets the Nett Quantity Price Break at level 4|Product.NettPriceBreak4|productNettPriceBreak4|
|NettPriceBreak4ExGST|TBA|Product.NettPriceBreak4ExGST|productNettPriceBreak4ExGST|
|NettPriceBreak4IncGST|TBA|Product.NettPriceBreak4IncGST|productNettPriceBreak4IncGST|
|NettPriceBreakPrice0|Gets the Nett Price Break Price at level 0|Product.NettPriceBreakPrice0|productNettPriceBreakPrice0|
|NettPriceBreakPrice0ExGST|Gets the Nett Price Break Price Ex Tax at level 0|Product.NettPriceBreakPrice0ExGST|productNettPriceBreakPrice0ExGST|
|NettPriceBreakPrice0IncGST|Gets the Nett Price Break Price Inc Tax at level 0|Product.NettPriceBreakPrice0IncGST|productNettPriceBreakPrice0IncGST|
|NettPriceBreakPrice1|Gets the Nett Price Break Price at level 1|Product.NettPriceBreakPrice1|productNettPriceBreakPrice1|
|NettPriceBreakPrice1ExGST|Gets the Nett Price Break Price Ex Tax at level 1|Product.NettPriceBreakPrice1ExGST|productNettPriceBreakPrice1ExGST|
|NettPriceBreakPrice1IncGST|Gets the Nett Price Break Price Inc Tax at level 1|Product.NettPriceBreakPrice1IncGST|productNettPriceBreakPrice1IncGST|
|NettPriceBreakPrice2|Gets the Nett Price Break Price at level 2|Product.NettPriceBreakPrice2|productNettPriceBreakPrice2|
|NettPriceBreakPrice2ExGST|Gets the Nett Price Break Price Ex Tax at level 2|Product.NettPriceBreakPrice2ExGST|productNettPriceBreakPrice2ExGST|
|NettPriceBreakPrice2IncGST|Gets the Nett Price Break Price Inc Tax at level 2|Product.NettPriceBreakPrice2IncGST|productNettPriceBreakPrice2IncGST|
|NettPriceBreakPrice3|Gets the Nett Price Break Price at level 3|Product.NettPriceBreakPrice3|productNettPriceBreakPrice3|
|NettPriceBreakPrice3ExGST|Gets the Nett Price Break Price Ex Tax at level 3|Product.NettPriceBreakPrice3ExGST|productNettPriceBreakPrice3ExGST|
|NettPriceBreakPrice3IncGST|Gets the Nett Price Break Price Inc Tax at level 3|Product.NettPriceBreakPrice3IncGST|productNettPriceBreakPrice3IncGST|
|NettPriceBreakPrice4|Gets the Nett Price Break Price at level 4|Product.NettPriceBreakPrice4|productNettPriceBreakPrice4|
|NettPriceBreakPrice4ExGST|Gets the Nett Price Break Price Ex Tax at level 4|Product.NettPriceBreakPrice4ExGST|productNettPriceBreakPrice4ExGST|
|NettPriceBreakPrice4IncGST|Gets the Nett Price Break Price Inc Tax at level 4|Product.NettPriceBreakPrice4IncGST|productNettPriceBreakPrice4IncGST|
|NettPriceForOne|Gets price of 1 of this product|Product.NettPriceForOne|productNettPriceForOne|
|NettPriceForOneEx|Gets price of product ex-tax for quantity of 1 of the product|Product.NettPriceForOneEx|productNettPriceForOneEx|
|NettPriceForOneExOrMessage|Gets price (with discount) of product ex-tax for quantity of 1 of the product|Product.NettPriceForOneExOrMessage|productNettPriceForOneExOrMessage|
|NettPriceForOneInc|Gets price of product inc-tax for quantity of 1 of the product|Product.NettPriceForOneInc|productNettPriceForOneInc|
|NettPriceForOneIncOrMessage|Gets price (with discount) of product inc-tax for quantity of 1 of the product|Product.NettPriceForOneIncOrMessage|productNettPriceForOneIncOrMessage|
|NettPriceForOneOrMessage|Gets price (with discount) of 1 of this product|Product.NettPriceForOneOrMessage|productNettPriceForOneOrMessage|
|NettPriceForOneString|TBA|Product.NettPriceForOneString|productNettPriceForOneString|
|NettTaxForOne|Gets tax portion for price of product for quantity of 1|Product.NettTaxForOne|productNettTaxForOne|
|NumberOfReviews|TBA|Product.NumberOfReviews|productNumberOfReviews|
|OnContract|TBA|Product.OnContract|productOnContract|
|OrderLineNote|TBA|Product.OrderLineNote|productOrderLineNote|
|Picture1|TBA|Product.Picture1|productPicture1|
|Picture1Image|TBA|Product.Picture1Image|productPicture1Image|
|PriceBreak0|TBA|Product.PriceBreak0|productPriceBreak0|
|PriceBreak0ExGST|TBA|Product.PriceBreak0ExGST|productPriceBreak0ExGST|
|PriceBreak0IncGST|TBA|Product.PriceBreak0IncGST|productPriceBreak0IncGST|
|PriceBreak1|TBA|Product.PriceBreak1|productPriceBreak1|
|PriceBreak1ExGST|TBA|Product.PriceBreak1ExGST|productPriceBreak1ExGST|
|PriceBreak1IncGST|TBA|Product.PriceBreak1IncGST|productPriceBreak1IncGST|
|PriceBreak2|TBA|Product.PriceBreak2|productPriceBreak2|
|PriceBreak2ExGST|TBA|Product.PriceBreak2ExGST|productPriceBreak2ExGST|
|PriceBreak2IncGST|TBA|Product.PriceBreak2IncGST|productPriceBreak2IncGST|
|PriceBreak3|TBA|Product.PriceBreak3|productPriceBreak3|
|PriceBreak3ExGST|TBA|Product.PriceBreak3ExGST|productPriceBreak3ExGST|
|PriceBreak3IncGST|TBA|Product.PriceBreak3IncGST|productPriceBreak3IncGST|
|PriceBreak4|TBA|Product.PriceBreak4|productPriceBreak4|
|PriceBreak4ExGST|TBA|Product.PriceBreak4ExGST|productPriceBreak4ExGST|
|PriceBreak4IncGST|TBA|Product.PriceBreak4IncGST|productPriceBreak4IncGST|
|PriceBreakPrice0|Gets the Price Break Price at level 0|Product.PriceBreakPrice0|productPriceBreakPrice0|
|PriceBreakPrice1|Gets the Price Break Price at level 1|Product.PriceBreakPrice1|productPriceBreakPrice1|
|PriceBreakPrice2|Gets the Price Break Price at level 2|Product.PriceBreakPrice2|productPriceBreakPrice2|
|PriceBreakPrice3|Gets the Price Break Price at level 3|Product.PriceBreakPrice3|productPriceBreakPrice3|
|PriceBreakPrice4|Gets the Price Break Price at level 4|Product.PriceBreakPrice4|productPriceBreakPrice4|
|PriceBreakQty0|Gets the Price Break Qty at level 0|Product.PriceBreakQty0|productPriceBreakQty0|
|PriceBreakQty1|Gets the Price Break Qty at level 1|Product.PriceBreakQty1|productPriceBreakQty1|
|PriceBreakQty2|Gets the Price Break Qty at level 2|Product.PriceBreakQty2|productPriceBreakQty2|
|PriceBreakQty3|Gets the Price Break Qty at level 3|Product.PriceBreakQty3|productPriceBreakQty3|
|PriceBreakQty4|Gets the Price Break Qty at level 4|Product.PriceBreakQty4|productPriceBreakQty4|
|PriceContract|TBA|Product.PriceContract|productPriceContract|
|PriceContractExGST|TBA|Product.PriceContractExGST|productPriceContractExGST|
|PriceContractIncGST|TBA|Product.PriceContractIncGST|productPriceContractIncGST|
|PriceCurrencySuffix|Shows the generic currency suffix or inc/ex GST depending on flags|Product.PriceCurrencySuffix|productPriceCurrencySuffix|
|PriceForOne|TBA|Product.PriceForOne|productPriceForOne|
|PriceForOneEx|TBA|Product.PriceForOneEx|productPriceForOneEx|
|PriceForOneExOrMessage|Show price (ex GST) or message based on attribute config on page|Product.PriceForOneExOrMessage|productPriceForOneExOrMessage|
|PriceForOneInc|TBA|Product.PriceForOneInc|productPriceForOneInc|
|PriceForOneIncOrMessage|Show price (inc GST) or message based on attribute config on page|Product.PriceForOneIncOrMessage|productPriceForOneIncOrMessage|
|PriceForOneOrMessage|Show price or message based on attribute config on page|Product.PriceForOneOrMessage|productPriceForOneOrMessage|
|PriceForOneString|TBA|Product.PriceForOneString|productPriceForOneString|
|PriceFromDefault|TBA|Product.PriceFromDefault|productPriceFromDefault|
|PriceFromFirst|TBA|Product.PriceFromFirst|productPriceFromFirst|
|PricePromotion|Formats the ProntoPriceRecord["PromPrice"] so this is essentially ex GST.|Product.PricePromotion|productPricePromotion|
|PricePromotionExGST|TBA|Product.PricePromotionExGST|productPricePromotionExGST|
|PricePromotionIncGST|TBA|Product.PricePromotionIncGST|productPricePromotionIncGST|
|ProductParsedListTemplate(String)|Property that returns a parsed template for this Product
Designed to replace WebServiceAjax.ProductSearchWithListTemplate and be able to use DynamicServices and call Product.GetProductWithFilter and part of the return list this method (ProductParsedListTemplate) is used|Product.ProductParsedListTemplate(String)|productProductParsedListTemplate(String)|
|ProductParsedListTemplateBatched(String, Boolean)|Property that returns a parsed template for THE WHOLE Product RECORDSET - will only return parsed data for first record
Assumes that the template has a CSSRepeat in it
Designed to replace WebServiceAjax.ProductSearchWithListTemplate and be able to use DynamicServices and call Product.GetProductWithFilter and part of the return list this method (ProductParsedListTemplate) is used|Product.ProductParsedListTemplateBatched(String, Boolean)|productProductParsedListTemplateBatched(String, Boolean)|
|QtyBox|TBA|Product.QtyBox|productQtyBox|
|QuantityInCart|TBA|Product.QuantityInCart|productQuantityInCart|
|RegistryListIDHiddenHtmlField|Used to render a html input hidden field for adding products for the RegistryListID contained in the querystring. The resource can take 2 params, the first
passed is a product code (only needed for the Product use of this token), is appendended after the hdnRegistryListID_ in the name tag, the second which gets
set to the value tag is for the RegistryListID.|Product.RegistryListIDHiddenHtmlField|productRegistryListIDHiddenHtmlField|
|RequestedDeliveryDateBox|TBA|Product.RequestedDeliveryDateBox|productRequestedDeliveryDateBox|
|ReviewSummary|TBA|Product.ReviewSummary|productReviewSummary|
|RRPEx|TBA|Product.RRPEx|productRRPEx|
|RRPExOrMessage|TBA|Product.RRPExOrMessage|productRRPExOrMessage|
|RRPInc|TBA|Product.RRPInc|productRRPInc|
|RRPIncOrMessage|TBA|Product.RRPIncOrMessage|productRRPIncOrMessage|
|RRPOrMessage|TBA|Product.RRPOrMessage|productRRPOrMessage|
|StocktakeQty|TOKEN: Renders out the the quantity of the current product counted in the user's
current User Stocktake for their current customer. Returns an empty string if
the feature is disabled.|Product.StocktakeQty|productStocktakeQty|
|UniqueBomLineTypeConfigurableKitComponents|Returns a ProntoBillOfMaterials set of unique BomLineTypes of configurable kit components for this product.|Product.UniqueBomLineTypeConfigurableKitComponents|productUniqueBomLineTypeConfigurableKitComponents|
|UserFavouritesProductDisplayIcon|Checks if the current product is in the list of user favourites. If so, returns a resource.|Product.UserFavouritesProductDisplayIcon|productUserFavouritesProductDisplayIcon|
The 'Resource Tool' allows you to determine what the possible tokens to use for Product are.
For an explanation of all tokens see Product Tokens list.
Step-by-step guide
To Determine All of the Resources Available for a Product:
- Login as an Administrator.
- Navigate to 'Preferences' --> 'System Preferences' (/zPrefs.aspx).
- Click the 'Tools' tab.
- Click the 'Resource Enquiry' tab.
- Click the 'Product' tab.
- Enter the following information:
- the Customer Code you wish to test
- the Role you wish to test
- the Product Code you wish to test
- Click the 'Enquire' button, and the system will perform the check for the parameters specified.
- The checks performed are listed.
- Checks that have passed are shaded green.
- Checks that have not passed are shaded red, and will include an explanation of why the check did not pass.
- If any check has failed and displayed red, some action will need to be taken to make the product available for the customer.
- Click the 'Details' link on any of the check results to see a full description of the check performed and its results.
- If all of the checks passed you will also get information on all of the possible resources available for that product, to that user, on that role.
| Info |
|---|
|
Customer Exists - Checks that the customer code exists in the web site database
Role Exists- Checks that the role exists
Product Exists- Checks that the product exists in the web site database. If it does not, you should check the product integration settings
|
| Note |
|---|
Available from 2014R1 Service Pack 1 or upon upgrade request. |
Related articles
| Content by Label |
|---|
| showLabels | false |
|---|
| max | 5 |
|---|
| spaces | DRAFTKB |
|---|
| sort | modified |
|---|
| showSpace | false |
|---|
| reverse | true |
|---|
| type | page |
|---|
| labels | product token |
|---|
|