Username Password
Bookmark and Share


If your Shop contains relatively few products, and if those products all relate to one another, it's fine to just add Product assets directly to a Page Layout. For larger Shops, you may want to categorize your Products. Shelf allows you to create a “shelf” in your shop to house Products that relate to one another. It is a container asset, so you will add a Shelf, and then fill it with Products to sell.

You don't have to add a Shelf to a Page Layout. You can add it directly to the site from any location. Like other container assets, it will appear one level lower in the site navigation from the current location.

In addition to placing assets directly on the Shelf, Shelf can also be populated using Metadata keywords. Any SKU asset on the site (Product, Donation, Subscription, Flat Discount Coupon) can be assigned a keyword in its Metadata tab. If a matching keyword is entered in the Keyword field of a Shelf asset's Metadata tab, the Shelf asset will pull in the SKU asset to display on the Shelf. When users click on an item they will be directed to the original asset. This is covered more later.


  1. Select Shelf from the New Content menu to open the Add/Edit Shelf screen.



  1. In the “Title” field enter a title for this Shelf.

  2. The “Menu Title” field is the title of this Shelf as it appears in the site navigation. If you leave this field blank, WebGUI will just use the title entered in the “Title” field for this field as well.

  3. The URL field is the URL of this asset. You can enter a URL, or leave it blank and WebGUI will create one for you.

  4. In the “Description” field you can enter text related to what will be displayed on this Shelf.

  5. Set your display settings in the Display tab.


    1. If “Hide from navigation?” is set to Yes, the menu title of this Shelf will be hidden in the site navigation. Because Shelf is a container asset, the default setting for this field is No, meaning the menu title of this Shelf will appear in the site navigation. If you don't want that, set this field to Yes.

    2. “Open in new window?” determines if this asset will open in a new browser window when selected from the site navigation.

    3. “Display the title?” determines if the title of this asset will be displayed on the body of the web page.

    4. The “Style Template” is the style template used to view this asset, similar to applying a style template to a Page Layout asset. If you have a custom style template for your Shelf asset, this is where you select it.

    5. The “Printable Style” is the template used to display a printer-friendly version of this asset.

    6. The “Shelf Template” is the template used to display this Shelf asset.

7. The Security tab allows you to determine who can view this Shelf on the site, and who can edit this Shelf asset. The Owner can always do both.



  1. The Metadata tab is the standard metadata screen common amongst most WebGUI assets. Shelf will allow you to use the Keywords field in the Metadata tab to display Products or other SKU assets from throughout the site that contain matching keywords.


For example, a number of Product assets are created on the site. Many of the Products are related to Hawaii, so in their Metadata tabs each related Product asset is assigned the Keyword “hawaii”.



Then, a Shelf asset is created on which to store all Hawaii related products. So, the Shelf asset is named Hawaii, and the same keyword, hawaii, is entered in the Keyword field in the Shelf asset's Metadata tab.


Upon saving the Shelf, the asset will display all the Product assets (or any other SKU asset on the site) with the matching keyword “hawaii” associated with them.


This will allow you to populate the Shelf asset using keyword associations, as opposed to manually adding Product assets to the Shelf asset. In this way, you can create any number of SKU's (Products, Subscriptions, Donations, Flat Discount Coupons) and place those assets anywhere on the site. Then, create categories within your Shop using the Shelf asset, and populate the Shelf assets representing each category based on keyword association. This can result in some overlapping in the event that two categories have identical keyword associations. For example, a Hawaiian shirt might have the keywords hawaii and shirt. This might result in it being displayed on two Shelf assets: one with the keyword hawaii, and one that displays clothing items with a keyword of shirt.


You might also use the keyword associations to your advantage when creating Flat Discount Coupons. A single Flat Discount Coupon asset can be created for your entire Shop (“shop today and save X amount”), but displayed on multiple Shelf assets. Because it is a single coupon asset, WebGUI will still only allow it to be applied to the total purchase one time.


  1. Click save to add your Shelf to the site.



Once you create a Shelf, you can add SKU assets, such as Product or Donation, to it, or use the Keyword field in the Metadata tab to pull in SKU assets with matching keyword associations. The image above shows a Shelf asset with three Product assets added to it. If the user clicks on the Hawaiian Shirt product name, or the product’s image, the user will be directed to the Product asset for that item. From there, the user can see variants of the product, learn more about the product and add the product to the cart. Alternatively, the user can select the variant of the Product and add it to the cart directly from the Shelf. 


Note: If you manually add a SKU asset to Shelf, it will become a child of the Shelf asset. Pulling in SKU assets for display on a Shelf asset via a Metadata keyword does not create child assets. Users will be directed to the actual SKU asset upon selecting it in Shelf.


(SKU assets include Product, Donation, Subscription, Flat Discount Coupon, and the EMS Ticket, Badge, Ribbon and Token.)


The Shelf asset contains a View Cart link in the default template, located in the upper right hand corner of the asset. This link will display the number of items currently in the user's cart. Clicking the View Cart link will direct the user to his/her shopping cart.


Import and Export Products

WebGUI Shop allows you to export data from existing Product assets from your shop to your computer in a .csv (comma separated value) file for use in an external inventory control system or to import into another WebGUI Shop.


To do so, edit a Shelf asset that contains Product assets as children. On the far right hand side of the Shelf asset add/edit screen is an “Export Products” link.



Clicking the Export Products link will download a .csv file to your computer containing data from the Product assets contained on this Shelf. WebGUI will open a page displaying this data upon clicking on the Export Products link.



The file can then be imported into an external spreadsheet application to manage product inventory, as seen above.


The Import option allows you to import many Products from an external .csv file, as an alternative to creating many Product assets. In some cases, you might be managing product inventory in an external application, and this would allow you to import Product data back into WebGUI Shop. If WebGUI finds a Product asset in the uploaded file, it will update its data on the site based on the data in the .csv file (quantity, price, title etc).


To import Products, edit a Shelf asset, and click on the “Import Products” link on the far right hand side of the Shelf add/edit screen. This will open the Import Products screen.



Click on the Choose File button, select the .csv file from your computer, and upload it. A message on the screen will indicate that the products have been imported.



WebGUI will import the products directly to the Shelf asset, so Shelf will be the parent asset and the Products will be contained under Shelf. To view the Products that you have imported, simply click the Back to Site link on the far right hand side of the screen. You will be returned to the Shelf asset on which the Products are now displayed.

Keywords: export import keyword metadata product shelf SKU

Search | Most Popular | Recent Changes | Wiki Home
© 2023 Plain Black Corporation | All Rights Reserved