Documentation

This is a list of some of the more important functions organized by site circuit. It provides a good overview of how the site is structured and helps explain the available functionality.

HOME
The site's root (default) circuit

• Welcome (default) - index.cfm
  The site's home page.
• Admin - index.cfm?fuseaction=home.admin
  The main administration menu for the site. This menu can also be accessed automatically with the url www.sitename.com/admin. All the individual circuits admin menu options (listed in the various section below) are compiled in this single menu along with the following overall site definition pages:
  
  • Color Palettes - index.cfm?fuseaction=home.admin&colors=listMultiple color palettes can be defined for the site. A default color palette is set for the site overall and for individual categories, pages, etc. individually. This is also where you define different layout pages to use
  • Category & Page Templates - index.cfm?fuseaction=home.admin&catcore=list
    Used for adding new site templates.
  • Site Settings - index.cfm?fuseaction=home.admin&settings=edit
    Site definition and display variables.
  • Pick Lists- index.cfm?fuseaction=home.admin&picklists=editPick lists set the choices for various pull-down lists used in the site, defining things like 'feature types'.

ACCESS
Access refers to the functions that control the locking and access to site content. Categories and Features can be "locked" with an Access Key and only logged in members who possess the key will gain access to the content.

• Memberships - index.cfm?fuseaction=access.memberships
  The list of your (the currently logged in user) memberships. A link to memberships is included on the My Account page.
• File Downloads - index.cfm?fuseaction=access.download
  The list of your (the currently logged in user) files ready for download. This feature is used to fulfill purchases of downloadable software. A link to file downloads is included on the My Account page.
• Test - index.cfm?fuseaction=access.test
  A debugging tool to view the values of your (the currently logged in user) access keys. 
• Secure - Called as a custom tag within templates to secure access to site functionality and content.
• Admin - index.cfm?fuseaction=access.admin
  A menu of the Content Access functions listed below.
  
  • Access Keys List -  index.cfm?fuseaction=access.admin&accessKey=listAn administrator list of all access keys. Access Keys are created to "lock" site content. Keys are given to groups or individual users OR they can be "sold" in the form of a membership. Only users who possess a key can access the content locked with that key.
  • Membership List - index.cfm?fuseaction=access.admin&membership=listAn administrator listing of all memberships. Memberships are usually purchased by users for access to site content.

CATEGORY
Categories provide a hierarchal structure to the site. A Category consists of a header section followed by a listing of content such as sub-categories or Products or Features. In fact, Sub-Categories, Features and Products can all be listed on a single Category page.

• Display Category - index.cfm?fuseaction=category.display&category_id=*
  Displays the detail page of the requested category.
• Top Categories Menu - index.cfm?fuseaction=category.topcatmenuCalled as a custom tag on the layout page to insert a menu of top categories. Can be oriented horizontally or vertically using images or forced to text only.
• Sub-Category Menu - index.cfm?fuseaction=category.subcatmenuCalled as a custom tag on the layout page to inset a menu of the child categories of the currently displayed category.
• Related Categories List - index.cfm?fuseaction=category.related...
  Called as a custom tag on detail pages. It will list out all the categories that a product is listed in on the bottom of the product page and the categories that a feature is listed in on the feature page.
• Admin - index.cfm?fuseaction=category.adminDisplays a menu of the Category administrative functions listed below.
  • Categories List - index.cfm?fuseaction=category.admin&category=listAdministrative list of site categories. Allows the adding, editing and deleting of Categories. 

FEATURE
By Feature we mean  "Feature Articles" or text content pages. Features can be assigned to Categories just like Products or be linked to a Product.

• Feature List - index.cfm?fuseaction=feature.listFeatures are usually listed in one or more Category. However, this link can be called directly or as a Custom Tag on template pages to produce a list of Features. This page also provides the results for Feature Searches.
• Feature Search - index.cfm?fuseaction=feature.search
  Provides a search form to search Features.
• Display Feature - index.cfm?fuseaction=feature.display&feature_id=*
  Displays the detail page of the requested Feature.
• Related Features List - index.cfm?fuseaction=feature.relatedCalled as a custom tag. On the Product detail page, this custom tag inserts a list of the Product's related Features.
• Admin - index.cfm?fuseaction=feature.admin
  Displays a menu of the Feature administrative functions listed below:
  • Features List - index.cfm?fuseaction=feature.admin&feature=listAdministrative list of Features. Allows the adding, editing and deleting of Features.

PAGE
Site Pages provide editing and menu for the Shopping Cart, My Account, Search, Contact Us, Home and other "non-content" functions of the site.

• Page Menu - index.cfm?fuseaction=page.menuCalled as a custom tag on the layout template to insert a horizontal or vertical list of available site pages.
• Display Page - index.cfm?fuseaction=page.display&page_id=*
  Displays the requested page.
• Admin - index.cfm?fuseaction=page.admin
  Displays a menu of Page administrative functions listed below:
  • Pages List - index.cfm?fuseaction=page.admin&do=list

PRODUCT
Goods and services for sale on the site.

• Product List - index.cfm?fuseaction=product.list
  Products are usually listed in one or more Category and located by the browsing of Categories. However, this link can be called directly or as a Custom Tag on template pages to produce a list of Products. This page also provides the results for Product Searches.
• Product Search - index.cfm?fuseaction=product.searchProvides a search form to search Products.
• Display Product - index.cfm?fuseaction=product.display&product_id=*
  Displays the detail page of the requested product.
• Related Products List - index.cfm?fuseaction=product.related
  Called as a custom tag. This is used on the Product and Feature detail pages and Shopping Cart to list related products.
• Product of the Day  - index.cfm?fuseaction=product.productofday
  Usually called as a custom tag to insert the Product of the Day.
• Product Teaser - index.cfm?fuseaction=product.teaseCalled as a custom tag to insert a highlight box of products such as products on sale in a particular site category, etc.
• Admin - index.cfm?fuseaction=product.admin
  Displays a menu of the Product administrative functions listed below:
  • Products List - index.cfm?fuseaction=product.admin&do=listLists the site's products and allows for adding, editing and deleting.
  • Product Standard Options - index.cfm?fuseaction=product.admin&stdoption=listCreate and edit standard options that can easily be applied to products.
  • Product Standard Addons- index.cfm?fuseaction=product.admin&stdaddon=listCreate and edit standard products addons that can easily be applied to products.
  • Custom Product Fields - index.cfm?fuseaction=product.admin&fields=editAdd unique information fields to the products in your store.

SHOPPING
Store shopping cart and check-out functionality.

• Basket - index.cfm?fuseaction=shopping.basket
  Displays the content of the shopping cart.
• Wishlist- index.cfm?fuseaction=shopping.wishlist
  View, edit and add to the wishlist.
• Quick Order - index.cfm?fuseaction=shopping.quickorderProvides a form where multiple products can be added to the shopping cart at once.
• Order - index.cfm?fuseaction=shopping.order...
  This link provides a way to insert a product into the shopping cart from an HTML form.
• Basket Info - index.cfm?fuseaction=shopping.basketstatsA custom tag you can use to output a short summary of the basket totals.
• Order History - index.cfm?fuseaction=shopping.history
  Lists the user's order history and allows users to track the status of their order. A link to Order History is provided on the My Account page.
• Admin - index.cfm?fuseaction=shopping.admin
  Displays a menu of the Shopping administrative functions listed below:
  • Orders - index.cfm?fuseaction=shopping.admin&order=pendingA listing of new orders
  • Order Reports  - index.cfm?fuseaction=shopping.admin&order=reportsA variety of order reports available.
  • Discounts - index.cfm?fuseaction=shopping.admin&discounts=listCreate discounts that can be applied to products and categories.
  • Gift Certificates - index.cfm?fuseaction=shopping.admin&certificate=list
    Create gift certificates.
  • Shopping Cart Settings - index.cfm?fuseaction=shopping.admin&cart=editDefine the shopping cart settings for the store.
  • Shipping - index.cfm?fuseaction=shopping.admin&shipping=settings
    Define the shipping options available in the store.
  • Taxes - index.cfm?fuseaction=shopping.admin&taxes=codesDefine the tax codes and rates for the store.
  • Payments - index.cfm?fuseaction=shopping.admin&payment=cards
    Define the payment types available for the store.

USERS
Store customers and accounts.

• Login - index.cfm?fuseaction=users.loginPresents a log-in form.
• Logout - index.cfm?fuseaction=users.logout
  Used as a link to log a user out. Provided as a link on the My Account page.
• Password Help - index.cfm?fuseaction=users.forgotProvides a form where users can enter the email address they registered with and have their username and password emailed to them. This link is provided on the login form.
• Login Box - index.cfm?fuseaction=users.loginboxThis is a custom tag that inserts a persistent login/logout box on the site layout.
• User Manager - index.cfm?fuseaction=users.manager
  The My Account page which provides a user with all their user information and allows them to check their orders, update their information and create affiliate accounts.
• Address Book - index.cfm?fuseaction=users.addressbookUsers can create multiple addresses. The address book lists all the users' addresses and allow the user to define which address will be used as the default shipping, billing and account address.
• Email Edit - index.cfm?fuseaction=users.emailA form to allow users to update their email address. Provided as a link on the My Account page.
• Password Edit - index.cfm?fuseaction=users.passwordA form to allow users to update their password. Provided as a link on the My Account page.
• Subscribe - index.cfm?fuseaction=users.subscribe
  This link toggles on and off the "subscribe" setting of the current user. It is provided as a link on the My Account page.
• User Registration
  There are 3 different user registration forms available depending on the type of store. The REGISTER type (users.register) is the standard registration process of creaing a login, adding billing and shipping information and optional account information. The MEMBER registration (users.member) is used for membership sites that don't require shipping address information and provides all the registration information on a single page. The ACCOUNT registration (users.account) provides a single sign-up page for users opening up an Account.
• Verify Email Address  - index.cfm?fuseaction=users.unlock The user registration process can be set to automatically verify a user's email address. Used primarily for membership sites. An automated "unlock key" is emailed to a user and the user must enter the key into this form to complete the registration process.
• Directory - index.cfm?fuseaction=users.directoryProvides a listing of Accounts. Intended for stores who want to list retail locations where their products are available.
• Kill -  index.cfm?fuseaction=users.killA useful command when developing and testing the shopping cart. Users.kill will REALLY log you out completely and delete the store cookies.
• Admin - index.cfm?fuseaction=users.adminDisplays a menu of the User administrative functions listed below:
  • Settings- index.cfm?fuseaction=users.admin&settings=editControls all the store settings related to how you wish to handle users and accounts in your store.
  • Users - index.cfm?fuseaction=users.admin&user=list
    Login information for site users.
  • Groups - index.cfm?fuseaction=users.admin&group=listDefine groups that users can be placed in. Groups can be assigned discounts, site permissions and access keys.
  • Addresss - index.cfm?fuseaction=users.admin&customer=listUsers' billing, shipping and other addresses.
  • Accounts - index.cfm?fuseaction=users.admin&account=listBusiness account information. Accounts were intended for stores that sell wholesale.
  • Send Email - index.cfm?fuseaction=users.admin&email=selectSend an email to subscribed users, affiliates or selected group.
  • Download Users - index.cfm?fuseaction=users.admin&download=user_custDownload all user information to an Excel file.

AFFILIATE
Affiliate functionality allows users to sign up as a store Affiliate and earn commission on sales that come from users who are referred by them from their web site.

• Register  - index.cfm?fuseaction=shopping.affiliate&do=register
  Enrolls the user in the Affiliate program by assigning an Affiliate ID. A link to the Affiliate Registration is provided on the My Account page.
• Affiliate Links - index.cfm?fuseaction=shopping.affiliate&do=links
  An instruction page on how to create a referring link to place on anther web site. 
• Affiliate Report - index.cfm?fuseaction=shopping.affiliate&do=report
  A list of affiliate sales.

SITE SEARCH
Site-wide search functionality is provided as a standard site Page and can be listed in the Page menu. Search results will include categories, features, and products.

EMAIL FUNCTIONS
The site provides the following email functions:

• Contact Us Form - A "contact us" email form is included as a standard Page and as a catcore file that can be assigned to a category. The form allows users to enter a message that is automatically emailed to the site editor.
• Tell A Friend and Email the Editor pop-up window - A link to the email/index.cfm page can be used on template pages to pop-up a window to either send an email to a friend or to the editor. See details on the page. This link is used at the bottom of the Feature page to "email page".

ERRORS
A customizable default error handling page is included that will allow the user to email the error information to the site editor.

SITE SET-UP
To set the site up you simply need to do the following:

• Set up your datasource on the server pointing to the database file in the database directory.
• Update the database/database.cfm page with the name of your datasource.
• Log into the store with the default Administrator username and password ("admin" for both) and go to Site Settings in the Admin menu. Update the site's url and other information. 

CUSTOM TAGS
The site uses a few custom tags worthy of mentioning. These tags are referenced relationally and do NOT need to be "installed".

• FCKeditor - The site uses the FCKeditor on the administrative pages. The documentation is included in the Custom Tags folder.
• CF_aVarTree Versioin 1.61 - This custom tag prints out all the appliation, client, cookie, request, session and URL variables for debugging purposes. The sample default layout includes the tag at the bottom of the template. Appending "&debug=1" to any url will activate the tag IF you are logged on with Administrator privileges.
• QForms - The site uses QForms to produce javascript form field error processing. The full Qforms information and documentation will be found in the Includes directory.