Help: Product Template
For more help, visit the WebGUI Community Wiki.
- canEdit
- A boolean that is true if the user can edit this Product.
- brochure_icon
- The URL to the icon for the brochure.
- brochure_url
- The URL to download the brochure.
- brochure_label
- The translated label for the brochure URL.
- manual_icon
- The URL to the icon for the manual.
- manual_url
- The URL to download the manual.
- manual_label
- The translated label for the manual URL.
- warranty_icon
- The URL to the icon for the warranty.
- warranty_url
- The URL to download the warranty.
- warranty_label
- The label for the warranty URL.
- image1
- The unique identifier for the storage object for the first image.
- thumbnail1
- The URL to the thumbnail of the first image uploaded to this product.
- image2
- The unique identifier for the storage object for the second image.
- thumbnail2
- The URL to the thumbnail of the second image uploaded to this product.
- image3
- The unique identifier for the storage object for the third image.
- thumbnail3
- The URL to the thumbnail of the third image uploaded to this product.
- addfeature_url
- The URL to add a feature to this product.
- addfeature_label
- The translated label for the add feature link.
- feature_loop
- This loop contains all of the features associated with this product.
- feature_controls
- The WebGUI management controls for this feature.
- feature_feature
- The text of the feature itself.
- addbenefit_url
- The URL to add a benefit to this product.
- addbenefit_label
- The translated label for the add benefit link.
- benefit_loop
- This loop contains the benefits for this product.
- benefit_benefit
- The benefit text itself.
- benefit_controls
- The WebGUI management controls for this benefit.
- addvariant_url
- A URL to allow new variants to be added to this product.
- addvariant_label
- The translated label for the add variant link.
- variant_loop
- A loop containing all the variants for this product.
- variant_id
- The unique identifier for this variant.
- variant_controls
- An icon toolbar for editing, deleting, or reordering this variant.
- variant_sku
- The SKU for this variant.
- variant_title
- The title, or short description, for this variant.
- variant_price
- The price for this variant.
- variant_weight
- The weight for this variant.
- variant_quantity
- The quantity for this variant.
- in_stock
- A boolean which says whether or not there are available variants of this product for sale
- no_stock_message
- An internationalized message saying that there are no variants of this product available for sale.
- buy_form_header
- HTML code to start the form for putting variants into a shopping cart.
- buy_options
- A dropdown list of available variants for this product. Only variants with a quantity greater than zero are listed.
- buy_button
- The submit button for the form, with internationalized text.
- buy_form_footer
- HTML code to end the form for putting variant into a shopping cart.
- hasAddedToCart
- A condition indicating that the user has added the product to their cart, so we can display the thank you message.
- thankYouMessage
- Write a thank you message to your user for buying something from your site. Be sincere, or they may cancel their purchase and get it from Amazon instead.
- continueShoppingUrl
- A URL to reset the Product so that the user can continue shopping.
- addspecification_url
- The URL to add a specification to this product.
- addspecification_label
- The translated label for the add specification link.
- specification_loop
- The list of specifications associated with this product.
- specification_controls
- The WebGUI management controls for this specification.
- specification_specification
- The text of the specification itself.
- specification_units
- The units for this specification. ex: meters
- specification_label
- The label for this specification. ex: height
- addaccessory_url
- The URL to add an accessory to this product.
- addaccessory_label
- The translated label for the add accessory link.
- accessory_loop
- This loop contains all of the accessories associated with this product.
- accessory_url
- The URL to the linked accessory.
- accessory_title
- The title of the linked accessory.
- accessory_controls
- The WebGUI management controls for this accessory.
- addRelatedProduct_url
- The URL to add a related product to this product.
- addRelatedProduct_label
- The translated label for the add related product link.
- relatedproduct_loop
- This loop contains all of the products related to this product.
- relatedproduct_url
- The URL to the related product.
- relatedproduct_title
- The title of the related product.
- relatedproduct_controls
- The WebGUI management controls for this related product.
- cacheTimeout
- The amount of time in seconds output from this Asset will be cached.
- templateId
- The ID of the template that will be used to display this Asset.
- price
- The price of this Product.
- image1
- The unique identifier for the storage object for the first image.
- image2
- The unique identifier for the storage object for the second image.
- image3
- The unique identifier for the storage object for the third image.
- brochure
- The unique identifier for the storage object for a product brochure .
- manual
- The unique identifier for the storage object for a product manual.
- warranty
- The unique identifier for the storage object for a product warranty.
- sku
- Stands for Stock Keeping Unit, which is just a fancy term for an inventory code or product number.
- description
- Describe the product or service here.
- displayTitle
- Indicate whether the title should be displayed or not.
- vendorId
- Which person/company defined in the commerce system should get credit for selling this item, if any?
- shipsSeparately
- If set to yes, then this Sku will incur additional, independent shipping costs, rather than sharing costs with other items in a cart.
- assetId
- The unique identifier for this Asset, in base64 encoding.
- assetIdHex
- The unique identifier for this Asset, in hexadecimal format.
- title
- The title of the Asset
- menuTitle
- The title of the Asset used in Navigations.
- url
- The Asset's URL.
- isHidden
- A boolean that will be true if this Asset is set not be displayed in Navigations.
- newWindow
- A boolean that will be true if this Asset is set open in a new browser window.
- encryptPage
- A boolean that will be true if this Asset is set to be served over SSL.
- ownerUserId
- The ID of the user who owns this Asset.
- groupIdView
- The ID of the group that is allowed to view this Asset.
- groupIdEdit
- The ID of the group that is allowed to edit this Asset.
- synopsis
- A short description of the contents of the Asset.
- extraHeadTags
- Extra tags that will be added to the header of the page containing the Asset. These will be included by default so you do not need to add them youself, unless you want them to be in there twice.
- isPackage
- A boolean that will be true if this Asset is set to be a Package.
- isPrototype
- A boolean that will be true if this Asset is set to be a prototype.
- status
- With respect to version control, the status of this Asset. Typically these are the English strings "approved", "pending", "committed".
- assetSize
- How big this asset is in bytes. The sum of all database fields and attachments.
- keywords
- This will be a string with the keywords for this asset. Individual keywords will be joined with spaces, unless the keyword contains spaces, in which case it will be quoted.
- webgui.version
- The version of WebGUI on your site.
- webgui.status
- The release status for this version of WebGUI (stable, beta, gamma, etc.)
- session.user.username
- The current user's username.
- session.user.firstDayOfWeek
- From the current user's profile, the day they selected to be the first day of the week.
- session.config.extrasurl
- From the WebGUI config, the URL for the extras directory.
- session.var.adminOn
- This variable will be true if the user is in Admin mode.
- session.setting.companyName
- From the WebGUI settings, the company name.
- session.setting.anonymousRegistration
- From the WebGUI settings, whether or not anonymous registration has been enabled.
- session form variables
- Session Form Variables
Any form variables will be available in the template with this syntax:
<tmpl_var session.form.variable>
If there is more than 1 value in a form variable, only the last will be returned. - session scratch variables
- Session Scratch Variables
Any scratch variables will be available in the template with this syntax:
<tmpl_var session.scratch.variable>
- controls
- These are the icons and URLs that allow editing, cutting, copying, deleting and reordering the Asset.
Admin Console
