Definition of Terms
The following is a list of all of the common terms used throughout the Cartweaver 4 application and this documentation.
Note: All documentation located on this address: http://docs.cartweaver.com refers to Cartweaver 4 php or Cartweaver 4 ColdFusion, so any reference to "Cartweaver" with or without the "4" in this documentation does not apply to any previous version of Cartweaver.
- Admin Files: All files in the Cartweaver Administration section.
- Administration Area: Cartweaver comes complete with a full online Administration Area for managing your online store. The Administration Area is located at http://www.YourCartweaverStore.com/cw4/admin/.
- Application Files: These are files needed to make Cartweaver function but are not visible to the shopper.
- Archived: To maintain data referential integrity some records cannot be deleted if they have associated records; product SKUs with associated orders for example. In these situations the records can be archived, meaning they are hidden from the web and moved off of main Admin lists to Archive lists.
- Cart Files: Cart files are all the files that are visible to the shopper or related to these files via < includes >.
- Cartweaver Store Root Folder: The Cartweaver store root folder is the directory where you installed Cartweaver.
- Functional Includes: All of Cartweaver’s cart functionality is placed in your site's presentation files via functional < includes >In-line commenting is used extensively to explain what these includes are doing.
- Payment Gateway: A payment gateway is a third party that processes credit card information for you in real time. The transaction is processed in-line and the page will not be completed until a response is received from the gateway. This allows the rest of the code on the page to be processed based on the results of the gateway transaction. This transaction is invisible to the shopper. Common examples of payment gateways are PayPal's Payflow Pro and Authorize Net.
- Payment Processor: When interacting with a payment processor, the transaction takes place non-real-time. The order is written to the Cartweaver database, and then the customer enters their payment information on the processor’s website. The results will be sent separately to the merchant or to your application via email or to a different file that the processor’s server is pointed to. In this situation some sort of order verification and validation system must be put in place to update the order records to show when the credit card transaction has been completed and the payment is valid, or not. Common examples of this type of system are PayPal and WorldPay select Junior.
- Presentation Files: Presentation files contain your design and user interface. You will be adding Cartweaver functionality to your presentation files via the Cartweaver 4 CF extension suite, or if you are hand coding in Dreamweaver’s Code view or in Eclipse, NotePad++ or CF Builder you will be adding Cartweaver functionality via <cfinclude> tags. Separating form from function this way makes your application easy to design, customize and maintain.
- Product: A product ID is a unique ID for a particular product. Product IDs must be unique within the database.
- Server Side Includes: This refers to how Cartweaver 4 code is called to your presentation pages. The PHP version uses PHP inclides <?php include(""); ?> - the ColdFusion version uses <cfinclude> or <cfmodule> For this documentation we will simply use the term < includes > to refer to these reguardless of the version of Cartweaver 4you are using.
- SKU (also referred to as Product SKU): SKU stands for Stock Keeping Unit. This is the industry standard way to refer to a specific product item. Consult the Cartweaver 4 Step-By-Step section for more explanation on how SKUs function in Cartweaver 4.
- Supporting Files: Supporting files refers to the additional files installed with Cartweaver 4, which do not qualify as admin files, application files, functional includes, or presentation files.
- Target Page: The go-to page for a Cartweaver functional include is called a target page. For example, when you click View Cart the target page will be the presentation page cart.php or cart.cfm, but the target page can be customized to fit your naming scheme. The target page variables are set in the Cartweaver Admin.
- Tax Group: Tax Groups define a collection of products that are similarly taxed. Examples of tax groups might include “Electronics”, “Books”, or “Food Items”. Each Tax Group should uniquely identify a single collection of products that should be taxed
- Tax Region: A Tax Region is the physical location that taxes will be based upon. Tax Regions can either be entire countries, or individual states or provinces within a country. Each Tax Region can have it’s own Tax Rates for each Tax Group defined.
- Tax Rate: A Tax Rate is a percentage to be charged on an item in a particular Tax Group and Tax Region. Tax Rates can differ between groups and between regions. For example, the Tax Rate for “Books” (the Tax Group) in the “United Kingdom” (the Tax Region) can be different than the Tax Rate for “Books” in the “United States: Texas” (the Tax Region).