Consumer direct starter store: Implementation details

Task Command JSP
Add SKU to shopping cart OrderItemAdd
Add product to shopping cart OrderItemAdd
Change password UserRegistrationUpdate
Create address book AddressBookForm
Enter billing address OrderCopy
UpdateQuickCheckoutProfileView
Enter recipient information SendWishListMsg
Enter search criteria CatalogSearchResultView
Enter shipping address OrderItemUpdate
UpdateQuickCheckoutProfileView
Log on Logon
Remove unavailable item from cart OrderItemDelete
Select advertised product ProductDisplay
Select product ProductDisplay
Select product from search result ProductDisplay
Select product from wish list ProductDisplay
Select shipping method OrderItemUpdate
UpdateQuickCheckoutProfileView
Select store category CategoryDisplay
Select subcategory CategoryDisplay
Select suggested product ClickInfo
Send the wish list SendWishListMsg
Submit registration form UserRegistrationAdd
Update address book AddressAdd
Update quick checkout profile UpdateQuickCheckoutProfileView
Update registration information UserRegistrationUpdate
View order detail OrderDetail
View order history TrackOrderStatus

AccountDisplay.jsp

This JSP will display the Account page with the following information:
- 'Register' button
- Logon form, with Logon ID and Password field
- 'Forgot your password?' link



This page uses the following commands:

 





AddressBookForm.jsp

This JSP shows the Address Book page, which lists all the addresses added by the users.
Next to each address are two buttons: 'Edit' and 'Delete'.
If the customer clicks 'Delete', the corresponding address is deleted. If the customer clicks 'Edit', the Address Form page will be displayed.
Also, there is an 'Add a new address' button for customers to add new addresses.



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.user.beans.AddressBookDataBean


AddressEntryForm.jspf

This JSPF shows the following entry fields: First Name, Last Name, Address Information (i.e. Street address, City, State/Province, etc).
The layouts of these entry fields are different depending on the locale.




AddressEntryForm_CN_TW.jspf

This JSPF shows the following entry fields: First Name, Last Name, Address Information (i.e. Street address, City, State/Province, etc).
The layouts of these entry fields are different depending on the locale.




AddressEntryForm_FR_DE.jspf

This JSPF shows the following entry fields: First Name, Last Name, Address Information (i.e. Street address, City, State/Province, etc).
The layouts of these entry fields are different depending on the locale.




AddressEntryForm_JP_KR.jspf

This JSPF shows the following entry fields: First Name, Last Name, Address Information (i.e. Street address, City, State/Province, etc).
The layouts of these entry fields are different depending on the locale.




AddressForm.jsp

This JSP is used for both adding and updating an address.
This page will display the address form with the following fields:
- Nickname
(if the page is for adding address, the Nickname field will be an input box. Otherwise, the Nickname in the database will be displayed.
- First name, Last name
- Address Information
(i.e. Street address, City, State/Province, ZIP code/Postal Code, Country/Region, Phone number)



This page uses the following commands:

 





AdvancedCatalogSearchForm.jsp

This JSP page allows a customer to submit multiple searching criteria to find catalog entries. The following searching criteria are supported:
-- The price range of a catalog entry
-- The type of the search target, such as product, item, bundle, or kit
-- Any phrase in the description or name of a search target
-- Any phrase that should be exluded from the description or name of a search target
-- Which categories the search target should be in



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.catalog.beans.CatalogDataBean

com.ibm.commerce.common.beans.CurrencyDescriptionDataBean


AssociateCatentriesDisplay.jspf

The page is included by MerchandisingAssociationsDisplay.jsp to display catentries for different association types (Cross Sell, Up Sell, Accessory and Replacment).
To allow better reuse, this page is created because the logic to display catentries is the same for different association types.



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean


BillingAddressDisplay.jsp

This page either lists all the users addresses for the selection of a billing address
(with a button which links to AddressForm to create a new address entry)
or it presents the user with a form to enter a billing address.



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.order.beans.OrderDataBean

com.ibm.commerce.user.beans.AddressBookDataBean

com.ibm.commerce.user.beans.UserRegistrationDataBean


BundleDisplay.jsp

This JSP imports CachedBundleDisplay.jsp to display bundle details.
It also imports header, sidebar, and footer.




CachedBundleDisplay.jsp

This JSP will display more details about the products and the items that compose the bundle.
It shows the following information:
- Bundle full-sized image, name and long description
- All the products in this bundle. For each product, it shows the following:
- Full-sized image, name, and long description
- Contract price and list price
- Quantity box to enter the quantity
- A list of defining attributes (size and color) if the product has variations, and a list of values for each attribute (red and blue for color and Large and X-Large for size)
- Descriptive attributes, which are simply displayed as 'name:value'
- Applicable discount to the product
- All the items in this bundle. For each item, it shows the following:
- Full-sized image, name, and long description
- Contract price and list price
- Quantity box to enter the quantity
- Defining and Descriptive attributes, which are displayed as 'name:value'
- Applicable discount to the bundle
- 'Add to shopping cart' button, 'Add to wish list' button for B2C
Note: All items in a bundle are sold separately. After the bundle has been added to the shopping cart, the items in the shopping cart are separate order items.



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.catalog.beans.BundleDataBean


CachedCategoriesDisplay.jsp

This page displays the category entries in the current category. The following entries will be displayed, if any, in order:
- Categories
- Products
- Bundles
- Packages
The parameter Top will be set to Y, if the current category is in the top level of the store catalog, otherwise the Top will
be empty. The parent category will be indicated for the current category in the page heading, if the current category is not
at the top level.



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.catalog.beans.CategoryDataBean


CachedFooterDisplay.jsp

This is included at the bottom of the page. It contains common links at the bottom
of the page which are similar to the header.



This page uses the following commands:

 





CachedHeaderDisplay.jsp

This JSP is called from HeaderDisplay.jsp and is cached based on the parameters passed in and defined in the cachespec.xml file.
The header includes the following information:
- Common links, such as 'Shopping Cart', 'Contact Us', 'Help', etc
- Category selection list that displays all categories and subcategories in the store.
- Top Categories list



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.catalog.beans.CatalogDataBean


CachedItemDisplay.jsp

This JSP will display the item details. It shows the following information:
- Item full-sized image, name and long description
- Discount description if available
- Item contract price and list price
- Defining and Descriptive attributes, which are displayed as 'name:value'
- Quantity box to enter the quantity (default is 1)
- 'Add to shopping cart' button and 'Add to wish list' button for B2C button for B2B



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.catalog.beans.CategoryDataBean

com.ibm.commerce.catalog.beans.ItemDataBean


CachedPackageDisplay.jsp

This JSP will display more details about the items that compose the prebuilt kit (Packages are also called prebuilt kits).
It shows the following information:
- Package full-sized image, name, long description and descriptive attributes
- Package contract price and list price
- All the items in this package. For each item, it shows the following:
- Full-sized image, name, and long description
- Defining and Descriptive attributes, which are displayed as name:value
- Quantity box to enter the quantity (default is 1)
- 'Add to shopping cart' button, 'Add to wish list' button for B2C
Note: Since all items in a prebuilt kit cannot be sold separately, a prebuilt kit counts as one item in the shopping cart.



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.catalog.beans.PackageDataBean


CachedProductItemDisplay.jsp

This JSP will display the product and all child items under this product.
It shows the following information:
- Product full-sized image, name and long description
- Product discount description if available
- Table listing the child items under this product.
- For each child item, it shows the following:
- Thumbnail image and name
- Item attributes (e.g. size and color)
- contract price and list price
- 'Add to shopping cart' button, 'Add to wish list' button for B2C button for B2B



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.catalog.beans.CategoryDataBean

com.ibm.commerce.catalog.beans.ProductDataBean


CachedProductOnlyDisplay.jsp

This JSP page displays the product details. It shows the following information:
- Full-sized image, name, and long description of the product
- Discount description for the product, if available
- Contract price and list price of the product
- A list of defining attributes (such as size and color) if the product has variations, along with a list of values for each attribute (for example, red and blue for color or large and x-large for size)
- Descriptive attributes, displayed as name:value
- 'Quantity' box to enter the quantity (default is 1)
- 'Add to shopping cart' button, 'Add to wish list' button for B2C stores, 'Add to Requisition List' button for B2B stores



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.catalog.beans.CategoryDataBean

com.ibm.commerce.catalog.beans.ProductDataBean


CachedSidebarDisplay.jsp

The sidebar includes the following information:
- Language selection box
- Currency selection box
- Categories structure, which lists the sibling sub categories (display only when the 2nd level category is selected)
- various other features (e.g. catalog search form)
- e-marketing spot



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.catalog.beans.CategoryDataBean


CachedTopCategoriesDisplay.jsp

This JSP page displays the following for each top category in a store:
- The thumbnail of the category
- The link to the page that displays details for the category (CategoriesDispaly.jsp)
- The category-level discounts will be displayed for each category



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.catalog.beans.CatalogDataBean


CatalogSearchResultDisplay.jsp

This JSP page displays the search results based on the search criteria input by a customer. The following features are supported:
-- Any invalid searching criteria will be indicated
-- If there is no result found, searching tips will be displayed
-- If there are more than a certain number of searching results, the results will be split into pages. The number of items per page can be specified by a customer.
-- The thumbnail, if any, for each search result will be displayed



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.catalog.beans.CategoryDataBean

com.ibm.commerce.common.beans.CurrencyDescriptionDataBean

com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean

com.ibm.commerce.search.beans.CatEntrySearchListDataBean


CategoriesDisplay.jsp

This JSP displays any store categories with the store's header, footer and sidebar. When it actually displays
the content of a category, it imports the page CachedCategoriesDisplay.jsp. The following three pages are imported:
- CachedHeaderDisplay.jsp, which displays the header of the page
- CachedCategoriesDisplay.jsp, which displays a category at a certain level
- CachedFooter.jsp, which displays the footer of the page



This page uses the following bean:

com.ibm.commerce.catalog.beans.CategoryDataBean


ContactDisplay.jsp

This JSP displays the store's contact information. It shows the following:
- Store name
- Full address



This page uses the following bean:

com.ibm.commerce.common.objects.StoreAddressAccessBean


DiscountDetailsDisplay.jsp

DiscountDetailsDisplay.jsp displays the details of a discount code
- for item level discounts, display short and long description of the discount and the associated items and a clickable short
description that links to the Item Display page
- for product level discounts, display short and long description of the discount and the associated products and a clickable
name that links to the Product Display page
- for category level discounts, display the short and long description of the discount



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.catalog.beans.CategoryDataBean

com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean


DiscountJavaScriptSetup.jsp

This file is included from a 'cached' catalog page and retrieves discounts for products, items, categories,
and packages based on the specified catalogEntryId's and catalogGroupId's. The JavaScript on this JSP was
created to support older Web browsers such as Netscape 4.xx.

This file serves two main purposes:
- Encapsulates discount code and keeps it in a single file
- Increases performance by allowing category and product pages to be cached while this page is not.
Since the catalog JSP's are cached, they cannot show dynamic discounts which are based on shopper attributes.
To show dynamic discounts, this page was created and not cached.
If you do not wish to support dynamic discounts, this JSP can be cached as well based on the following
URL parameters: storeId, catalogId, DC_langId, DC_curr, thisCategoryID, someCategoryIDs, someProductIDs, and someItemIDs

Parameters
- jsPrototypeName
Required. This specifies the class name for the generated JavaScript in this file. Can be any name without spaces

- thisCategoryID
An integer representing a single category ID to get discounts for
- thisCategoryIncludeChildItems
Boolean value specifying if the child category discounts should be retrieved as well
- thisCategoryIncludeParentCategory
Boolean value specifying if the parent category discounts should be retrieved as well

- someCategoryIDs
A comma delimitated string containing a set of category IDs to get discounts for
- categoryIncludeChildItems
Boolean value specifying if the child category discounts should be retrieved as well
- categoryIncludeParentCategory
Boolean value specifying if the parent category discounts should be retrieved as well

- someProductIDs
A comma delimitated string containing a set of product IDs to get discounts for
- productIsProdPromoOnly

- productIncludeChildItems
Boolean value specifying if the child item discounts should be retrieved as well
- productIncludeParentProduct
Boolean value specifying if the item's product discounts should be retrieved as well

- someItemIDs
A comma delimitated string containing a set of item IDs to get discounts for
- itemIsProdPromoOnly

- itemIncludeChildItems
Boolean value specifying if the child item discounts should be retrieved as well
- itemIncludeParentProduct
Boolean value specifying if the item's product discounts should be retrieved as well


This is an example of how this file could be included into a page:
<c:import url="${jspStoreDir}include/DiscountJavaScriptSetup.jsp">
<c:param name="jsPrototypeName" value="Discount" />
<c:param name="someItemIDs" value="${WCParam.productId}"/>
<c:param name="itemIncludeChildItems" value="false"/>
<c:param name="itemIsProdPromoOnly" value="false"/>
<c:param name="itemIncludeParentProduct" value="true"/>



The following JavaScript functions are generated from the input parameters
- getThisCategoryDiscountText() - returns discount text for the thisCategoryID parameter
- getCategoryDiscountText(categoryId) - returns discount text for the someCategoryIDs specified
- getProductDiscountText(productId) - returns discount text for the someProductIDs specified
- getItemDiscountText(itemId) - returns discount text for the someItemIDs specified
- getAreThereAnyDiscounts() - returns true if any discounts were found

Here is an example of how to put discount text for a specific category:




EmptyShopCartDisplay.jsp

The EmptyShopCartDisplay page is displayed when the user's shopcart contains no products.
A 'Continue shopping' button (links to Top Categories display page) is also displayed.



This page uses the following commands:

 





EnvironmentSetup.jspf

This file retrieves and prepares the JSP path, file path, and resource bundle, which are used by other JSPs
Since this file is called by many JSP files in the store, the commonly needed attributes are retrieved here.



This page uses the following bean:

com.ibm.commerce.common.beans.StoreDataBean


ErrorMessageSetup.jspf

This page is called by the JSP that requires error handling
It retrieves the store error message corresponding to the ECMessage key and the error code.



This page uses the following beans:

com.ibm.commerce.beans.ErrorDataBean

com.ibm.commerce.common.beans.StoreErrorDataBean


GenericError.jsp

This JSP is called whenever a generic error occurs in the store and no specific errorViewName
has been provided to redirect to. This page handles 2 situations:
- The store is set to closed or locked state
- All other generic errors
If the store is closed or locked, a message is displayed to the customer telling them the store is closed.
For all other errors, a generic error message is displayed.



This page uses the following bean:

ErrorDataBean


HelpDisplay.jsp

This JSP displays help tips to the customer. It shows the following information:
- How to complete an order
- How to make payment for an order
- Credit card security policy
- How to track an order




ItemDisplay.jsp

This JSP imports CachedItemDisplay.jsp to display item details.
It also imports header, sidebar, and footer.



This page uses the following bean:

com.ibm.commerce.catalog.beans.ItemDataBean


JSTLEnvironmentSetup.jspf

This file retrieves and prepares the JSP path, file path, and resource bundle, which are used by other JSPs
Since this file is called by many JSP files in the store, the commonly needed attributes are retrieved here.



This page uses the following bean:

com.ibm.commerce.common.beans.StoreDataBean


LogoffSetup.jsp

This page is called when a Logged in user tries to register again or
clicks on the 'forgot you password' link. The user is logged off and
redirected to another page.




LogonSetup.jsp

This JSP checks if a shopper is logged in or not.
If the shopper is logged in, the shopper will be redirected to the 'My Account' page.
Otherwise, the shopper will be directed to the 'Logon page'.



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.marketing.beans.EMarketingSpot


MerchandisingAssociationsDisplay.jsp

The page will show the cross-sell, up-sell, or accessory catalog entries if they are set up.
This JSP is included by the catalog entries pages (e.g. CachedProductOnlyDisplay.jsp).

Parameters
-catalogEntryType
This value is used to determine what bean to instantiate on this page. For example, if this
page is imported to display a merchandising association for a product, the catalogEntryType
would be ProductBean.
Possible values are:
- ProductBean
- ItemBean
- PackageBean
- BundleBean




This page uses the following bean:

com.ibm.commerce.catalog.beans.BundleDataBean


MiniShopCartDisplay.jsp

This file is used to display the Mini shopping cart in the sidebar of each page.
The Mini shopping cart will display
- current number of items that are currently in the shopping cart
- current subtotal of the items in the shopping cart



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.order.beans.OrderListDataBean


MultiAddressCheckout.jsp

This file displays the Order Items that are being ordered when Multiple Shipping Address options is enabled
- For each order item:
- Quantity
- Clickable item name (links to display page for order item. Product page provides 'Return to Checkout' button if 'summaryOnly' is passed from including page)
- Clickable shipping address for that order item (links to multiple shipping address view that allows shopper to set address per item via passed
parameter 'addressLink' from including page)
- Quick checkout shipping address text or Nickname for shipping address (option passed via parameter 'shippingText' from including page).
- Clickable shipping method (links to Checkout - select shipping method page. Option to turn this off for Quick checkout process via parameter
'shippingMethodLink' from including page)
- Option to display tracking number via parameter "trackingNumber" from including page.
- Price for each order item
- Clickable product level discount if applicable (links to the discount details display page)
- Total price for each order item (quantity adjusted)
This file is included into the Order submit form, Quick checkout form, Order confirmation & Order details pages



This page uses the following commands:

 




This page uses the following beans:

AddressDataBean

OrderDataBean

ShippingModeDescriptionDataBean

com.ibm.commerce.fulfillment.beans.ShippingModeDataBean


MultipleShippingAddressDisplay.jsp

This page allows the user to choose and define shipping addresses for each item in the order.
It is present during check out if the Accelerator "Change Flow" option "Multiple Shipping Addresses" is enabled.
The main content includes:
- Buttons to 'Create new address' and 'Edit address book'
- For each order item: quantity, clickable item description, and 'Ship to' dropdown selection.



This page uses the following commands:

 




This page uses the following beans:

CatalogEntryDataBean

OrderItemDataBean

com.ibm.commerce.catalog.beans.CatalogEntryDataBean

com.ibm.commerce.order.beans.OrderDataBean

com.ibm.commerce.user.beans.AddressBookDataBean

com.ibm.commerce.user.beans.UserRegistrationDataBean


MultipleShippingMethodDisplay.jsp

This page allows the user to choose a shipping method for each item in the order.
It is present during check out if the Accelerator "Change Flow" option "Multiple Shipping Methods" is enabled.
The main content includes:
- For each order item: quantity, clickable item description, and 'Shipping method' dropdown selection.



This page uses the following commands:

 




This page uses the following beans:

CatalogEntryDataBean

OrderItemDataBean

com.ibm.commerce.catalog.beans.CatalogEntryDataBean

com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean

com.ibm.commerce.order.beans.OrderDataBean


MyAccountDisplay.jsp

This JSP shows the My Account page with the following options:
- Change personal information
- Edit my address book
- Create or update Quick Checkout Profile
- View wish list
- View orders



This page uses the following commands:

 





NameEntryForm.jspf

This JSPF shows the following entry fields: First Name, Last Name
The layouts of these entry fields are different depending on the locale.




NameEntryForm_CN_TW.jspf

This JSPF shows the following entry fields: First Name, Last Name
The layouts of these entry fields are different depending on the locale.




NameEntryForm_JP_KR.jspf

This JSPF shows the following entry fields: First Name, Last Name
The layouts of these entry fields are different depending on the locale.




OrderAuthorizedNotify.jsp

This email JSP page informs the customer that the payment authorization for the customer's order is received.
It also provide the following order information:
- Information of each order item (such as item description, shipping address, shipping method)
- Tax, Shipping Charge, and Grand Total of the order



This page uses the following beans:

AddressDataBean

FormattedMonetaryAmountDataBean

OrderDataBean

PriceDataBean

ShippingModeDescriptionDataBean

StoreDataBean


OrderCanceledNotify.jsp

When there is a problem authorizing the customer's payment, this email will be sent.
This email JSP page informs the customer that the order cannot be completed and provide the following order information:
- Information of each order item (such as item description, shipping address, shipping method)
- Tax, Shipping Charge, and Grand Total of the order



This page uses the following beans:

AddressDataBean

FormattedMonetaryAmountDataBean

OrderDataBean

PriceDataBean

ShippingModeDescriptionDataBean

StoreDataBean


OrderConfirmationDisplay.jsp

This JSP will display the confirmation details of a single order. The content consists of:
- A receipt showing the order number, subtotal, total tax, shipping cost, and grand total.
- A print button
- includes MultiAddressCheckout.jsp to display items that were ordered along with associated order totals



This page uses the following beans:

OrderDataBean

com.ibm.commerce.payment.beans.PayStatusPMDataBean

com.ibm.commerce.payment.beans.UsablePaymentTCListDataBean


OrderDetailDisplay.jsp

This JSP will display the details of a single order. The content consists of:
- A receipt showing the order number, subtotal, total tax, shipping cost, and grand total.
- A print button
- includes MultiAddressCheckout.jsp to display items that were ordered along with associated order totals



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.order.beans.OrderDataBean


OrderItemDisplay.jsp

This page show the shopping cart for the user's order.

The main content panel shows:
- A breadcrumb trail for the checkout process
- For each order item:
- Quantity
- Clickable item short description (links to display page for order item)
- Attribute values for each order item
- Order item level promotion (if applicable)
- Listed price and item price (item price shown if less then listed price)
- Total price for each order item (quantity adjusted)
- Link to remove items from shopcart
- 'Update totals' button (used to recalculate shopcart contents after quantity field changed)
- Error status if there is a problem with the item
- 'Continue shopping' button (links to Top Categories display page)
- 'Quick checkout' button (links to Quick Checkout Summary page)
- 'Checkout' button (submits shopcart to begin checkout process)

The page also displays the 'ShoppingCartPage' eMarketing Spot at the bottom of the page



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.beans.ErrorDataBean

com.ibm.commerce.order.beans.OrderDataBean


OrderOKSetup.jsp

This JSP includes OrderConfirmationDisplay.jsp -- it is called after the order has been submitted




OrderReceivedNotify.jsp

This email JSP page informs the customer that the order is received and provide the following order information:
- Information of each order item (such as item description, shipping address, shipping method)
- Tax, Shipping Charge, and Grand Total of the order



This page uses the following beans:

AddressDataBean

FormattedMonetaryAmountDataBean

OrderDataBean

PriceDataBean

ShippingModeDescriptionDataBean

StoreDataBean


OrderStatusDisplay.jsp

This JSP will display a list of the orders that the shopper has completed to date. The content is a table with 3-4 columns.
- Order number with clickable link to take you to OrderDetailsDisplay.jsp
- Order date
- If the 'Track Order Status' feature in Commerce Accelerator is enabled for the store (Change Flow option in 'Store' menu), Order Status is shown
- Order total amount



This page uses the following commands:

 




This page uses the following beans:

OrderDataBean

com.ibm.commerce.order.beans.OrderListDataBean

com.ibm.commerce.payment.beans.PayStatusListPMDataBean


OrderSubmitForm.jsp

This page shows the order summary for the user's order(s)
The page has two major "Change Flow" (Accelerator, store menu) options that affect the code:
- Commerce Payments
- Multiple Shipping Address
The main content panel shows:
- includes MultiAddressCheckout.jsp if multiple shipping address flexflow option is turned on
- includes SingleAddressCheckout.jsp if single shipping address flexflow option is turned on
- Clickable billing address (links to billing address page)
- Payment information choices (includes, if appropriate, StandardCreditCard.jspf)



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.marketing.databeans.PromoCodeListDataBean

com.ibm.commerce.order.beans.OrderDataBean

com.ibm.commerce.payment.beans.UsablePaymentTCListDataBean

com.ibm.commerce.user.beans.AddressDataBean


PackageDisplay.jsp

This JSP imports CachedPackageDisplay.jsp to display package details.
It also imports header, sidebar, and footer.




PasswordNotify.jsp

After the customer has provided the necessary information on the Forget Password page, this email will be sent.
This email JSP page informs the customer about the newly reset password.
This JSP page is associated with PasswordResetNotification view in the viewreg table.




PasswordResetDisplay.jsp

This JSP page confirms that the password has been sent after the customer has provided the necessary information on the Forget Password page.



This page uses the following commands:

 





PasswordResetForm.jsp

This JSP displays an entry box prompting the customers to enter their Logon ID.
The customers type their Logon ID and click 'Send me my password' button.
The system then sends the password to the user's registered e-mail address if no error occurs.



This page uses the following commands:

 





PasswordUpdateForm.jsp

This JSP will display the ResetPassword form with the following fields:
- Current password
- New password
- New Verify password
If the user password expired, this page will be displayed after the user logs on.



This page uses the following commands:

 





PrivacyDisplay.jsp

This JSP displays the store's privacy policy. It shows the following information:
- How personal information is maintained
- How cookies are used by the store
- Important notices




ProductDisplay.jsp

This JSP imports CachedProductItemDisplay or CachedProductOnlyDisplay based on store configuration.
It also imports header, sidebar, and footer.



This page uses the following beans:

com.ibm.commerce.catalog.beans.CatalogEntryDataBean

com.ibm.commerce.catalog.beans.ProductDataBean


QuickCheckoutError.jsp

The uickCheckoutError page is displayed when the user has selected the QuickCheckout option on the shopcart page, but
the user is either not logged in or not registered. Quick checkout is currently only available to registered shoppers.
A 'Register or login' button is shown (links to Logon Form Display )



This page uses the following commands:

 




This page uses the following bean:

UserRegistrationDataBean


QuickCheckoutForm.jsp

This page shows the order summary for the user's order(s)
The page has two major "Change Flow" (Accelerator, store menu) options that affect the code:
- Commerce Payments
- Multiple Shipping Address
The main content panel shows:
- includes MultiAddressCheckout.jsp if multiple shipping address flexflow option is turned on
- includes SingleAddressCheckout.jsp if single shipping address flexflow option is turned on
- Clickable billing address (links to billing address page)
- Payment information choices (includes, if appropriate, StandardCreditCard.jspf)



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.marketing.databeans.PromoCodeListDataBean

com.ibm.commerce.order.beans.OrderDataBean

com.ibm.commerce.payment.beans.UsablePaymentTCListDataBean

com.ibm.commerce.user.beans.AddressDataBean


QuickCheckoutPrepare.jsp

QuickCheckoutPrepare executes the following server commands
- OrderItemUpdate (update shipping address)
- OrderItemUpdate (update shipping mode)
- OrderCopy (update billing address and payment information)
- OrderPrepare

Once the commands are executed, the user is redirected to a the QuickCheckoutForm



This page uses the following bean:

ControllerCommandInvokerDataBean


QuickCheckoutProfileForm.jsp

This page show allows the user to create a profile to be used during the Quick Checkout process. This page contains:

- A Billing address section which contains:
- 'First name' field to enter the user's first name
- 'Last name' field to enter the user's last name (required field)
- 'Street address' field to enter the user's address (required field)
- 'City' field to enter the user's city (required field)
- 'State/Province' field to enter the user's state or province (required field)
- 'Zip code/Postal code' field to enter the user's zip/postalcode (required field)
- 'Country/Region' field to enter the user's count/region (required field)
- 'Phone number' field to enter the user's phone number

- A Shipping address section which contains:
- a 'same as billing address above' check box which the user will select if their billing and shipping addresses are the same
- 'First name' field to enter the user's first name
- 'Last name' field to enter the user's last name (required field)
- 'Street address' field to enter the user's address (required field)
- 'City' field to enter the user's city (required field)
- 'State/Province' field to enter the user's state or province (required field)
- 'Zip code/Postal code' field to enter the user's zip/postalcode (required field)
- 'Country/Region' field to enter the user's count/region (required field)
- 'Phone number' field to enter the user's phone number

- A Available shipping methods section which contains:
- 'Regular mail' radio button for the user to select if they prefer shipping via regular mail
- 'Express mail' radio button for the user to select if they prefer shipping via express mail

- A Payment Information section which contains:
- 'Credit card type' drop down for the user to select their credit card type (American Express, MasterCard or Visa)
- 'Card number:' field for the user to enter their credit card number
- 'Expiration month' dropdown for the user to select the expiry month for their credit card
- 'Expiration year' dropdown for the user to select the expiry year for their credit card

- A 'submit' button which is used to save the Quick Check Out profile. (links back to the 'My Account' page once done)
- Note that If the user already has a profile, then the existing user profile is displayed allowing the user to update it



This page uses the following commands:

 




This page uses the following beans:

AddressDataBean

ShippingDataBean

com.ibm.commerce.beans.ErrorDataBean

com.ibm.commerce.payment.beans.PaymentPolicyListDataBean


QuickCheckoutUpdateProfile.jsp

This page executes the following server commands
- AddressAdd (add or update billing address)
- AddressAdd (add or update shipping address)
- OrderProfileUpdate

Once the commands are executed, the user is redirected to a the QuickCheckoutProfileForm



This page uses the following bean:

ControllerCommandInvokerDataBean


QuickOrderForm.jsp

This JSP page enables a shopper to add one or more items or packages into the shopping cart by directly entering the SKU for the items.



This page uses the following commands:

 





ReleaseShipNotify.jsp

This email JSP page informs the customer that the order is ready to ship.
It also provide the following order information:
- Information of each order item (such as item description, shipping address, shipping method)
- the shipping tracking number that the customer can use to track this package (if available)



This page uses the following beans:

AddressDataBean

ShippingModeDescriptionDataBean

com.ibm.commerce.common.beans.StoreDataBean

com.ibm.commerce.order.beans.OrderDataBean


SharedWishListDisplay.jsp

This page shows a wishlist that has been shared to you by another user

-A list of order items that a user has added to their wish list
- For each order item:
- Checkbox to select the item (used to select products that user wants to add to their shopcart)
- Clickable item name (links to display page for order item)
- Attribute values for each order item
- Item price
- 'Continue shopping' button (links to Top Categories display page)
- 'Add Selected items to shopping cart' button (adds item to Shopping Cart)



This page uses the following commands:

 




This page uses the following beans:

CatalogEntryDataBean

InterestItemDataBean

com.ibm.commerce.catalog.beans.CatalogEntryDataBean

com.ibm.commerce.catalog.beans.InterestItemListDataBean


SingleAddressCheckout.jsp

This file displays the Order Items that are being ordered when Single Shipping Address options is enabled
- For each order item:
- Quantity
- Clickable item name (links to display page for order item. Product page provides 'Return to Checkout' button if 'summaryOnly' is passed from including page)
- Clickable shipping method (links to Checkout - select shipping method page. Option to turn this off for Quick checkout process via parameter
'shippingMethodLink' from including page)
- Price for each order item
- Clickable product level discount if applicable (links to the discount details display page)
- Total price for each order item (quantity adjusted)
- Clickable shipping address for the order (links to single shipping address view that allows shopper to set address per item via passed
parameter 'addressLink' from including page)
This file is included into the Order submit form, Quick checkout form, Order confirmation & Order details pages



This page uses the following commands:

 




This page uses the following beans:

AddressDataBean

OrderDataBean

ShippingModeDescriptionDataBean


SingleShippingAddressDisplay.jsp

This page allows the user to choose and define shipping addresses for the order.
It is present during check out if the Accelerator "Change Flow" option "Single Shipping Address" is chosen.
The main content includes:
- Buttons to 'Create new address' and 'Edit address book'
- For each address: a radio button for the address (with the address printed beside it).



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.order.beans.OrderDataBean


SingleShippingMethodDisplay.jsp

This page allows the user to choose a shipping method for the order.
It is present during check out if the Accelerator "Change Flow" option "Single Shipping Method" is selected.
The main content includes:
- For each shipping method: description and delivery time



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean

com.ibm.commerce.order.beans.OrderDataBean


StandardCreditCard.jsp

This page fragment is included on both the QuickOrderForm (in QuickCheckoutSubsection) and OrderSubmitForm
It is present on the page if there are payment policies defined for credit cards for the store.
The main content includes:
- 'Credit card type' dropdown selection
- 'Card number' text input
- 'Expiration month' dropdown selection
- 'Expiration year' dropdown selection



This page uses the following bean:

com.ibm.commerce.order.objects.OrderPaymentInfoAccessBean


TopCategoriesDisplay.jsp

This JSP page displays the store's top-level categories. It is used as the starter store's homepage.
It imports three JSP pages:
- CachedHeaderDisplay.jsp, which displays the header of the page
- CachedTopCategoriesDisplay.jsp, which displays the top-level categories
- CachedFooter.jsp, which displays the footer of the page




UserLogonRouter.jsp

This JSP is typically the first JSP a shopper hits on the store.
The shopper is checked to see if they are a guest user. If the user is a guest, they are redirected
to the logon page. The user may also be a guest shoppers whos account is pending approval. If so,
they are brought back to the logon page and a message is displayed to them.




UserRegistrationAddForm.jsp

This JSP will display the registration form page with the following fields:
- E-mail, Password, Verify password
- First name, Last name
- Preferred language and Preferred currency
- Age and Gender
- Send me e-mail checkbox



This page uses the following commands:

 





UserRegistrationSetup.jsp

This Setup JSP includes 1 of 3 other pages (UserRegistrationAddForm, UserRegistrationUpdateForm, or PasswordUpdateForm) depending on what data
is being passed in the URL. Whenever the user is directed to this page, they are with registering, editing their registration or changing their password.




UserRegistrationUpdateForm.jsp

This JSP will display the change personal information page with the following fields:
- E-mail, Password, Verify password
- First name, Last name
- Preferred language and Preferred currency
- Age and Gender
- Send me e-mail checkbox



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.emarketing.beans.EmailUserReceiveDataBean

com.ibm.commerce.user.beans.UserRegistrationDataBean


WCParamValuesDisplay.jsp

This JSP is called from CachedSidebarDisplay.jsp which is a cached page. This JSP is not cached.
WCParamValuesDisplay.jsp takes all the parameters from the Request Attributes and puts them into hidden fields which can be
used in a form to redisplay the current page when a Language or Currency selection is made.




WishListDisplay.jsp

This page show the wishlist of a user and contains the following:

-A list of order items that a user has added to their wish list
- For each order item:
- Checkbox to select the item (used to select products that user wants to add to their shopcart)
- Clickable item name (links to display page for order item)
- Attribute values for each order item
- Order item level promotion (if applicable)
- Listed price and item price (item price shown if less then listed price)
- Total price for each order item (quantity adjusted)
- Link to remove items from wishlist
- 'Continue shopping' button (links to Top Categories display page)
- 'Add Selected items to shopping cart' button (adds item to Shopping Cart)

- A section to send your wish list friends and/or family. This section contains the following:
- A To 'E-mail address' field to enter the e-mail address of the recipient
- A From 'Name' field to enter the name of the user sending the Wish List
- A From 'E-mail address' field to enter the e-mail address of the user sending the Wish List
- A 'E-mail message' field to enter comments along with the email being sent
- A 'Send wish list' button to send the email to the recipeient's address



This page uses the following commands:

 




This page uses the following beans:

CatalogEntryDataBean

InterestItemDataBean

UserRegistrationDataBean

com.ibm.commerce.catalog.beans.CatalogEntryDataBean

com.ibm.commerce.catalog.beans.InterestItemListDataBean


WishListMessageConfirmationDisplay.jsp

This page indicates to the user that the wishlist e-mail was properly sent to the specified e-mail address.
A 'Continue shopping' button (links to Top Categories display page) is also displayed.



This page uses the following commands:

 




This page uses the following bean:

com.ibm.commerce.common.objects.StoreAddressAccessBean


eMarketingSpotDisplay.jsp

In the default "Consumer Direct" store, this file is included into the OrderItemDisplay.jsp and SidebarDisplay.jsp
to display eMarketingSpots in the Shopping Cart page and in the sidebar of the store pages.

This eMarketingSpot.jsp is built by customizing the eMarketingSpot.jsp sample snippet to fit the layout and flow of the
ConsumerDirect store.

This eMarketingSpot code supports all types of Campaign initiatives
- Products, items and category suggestions
- AdCopy - Awareness Advertisements
- Discount Advertisements
- Coupons Advertisements
- Merchandising Association - Cross-sell, Up-Sell, Accossories

If you intend to display only one type of the campaign initiatives in your eMarketingSpot, sections of the
code that will not be used can be removed.

Parameters
-emsName
This file can be reused in different pages of the store by including it and giving a unique
value for emsName, which should match exactly with an eMarketingSpot name that is defined in the
Accelerator tool.

-catalogId
catalogId needs to be passed in as it is required to build proper URL

-maxNumDisp
This value is used to set the maximum number of assets to display in an eMarketingSpot.
If this parameter is not passed in or is <0, then the default values will be used.
The default values are
- 4 - maximumNumberOfCatalogEntries
- 4 - maximumNumberOfCategories
- 3 - maximumNumberOfCollateral
- 4 - maximumNumberOfAssociateCatalogEntries

-maxItemsInRow
This value is used to set the maximum number of CatalogEntries, Categories and AssociateCatalogEntries assets
to display in a row.
If this parameter is not passed in or is <0, then the default value of 4 will be used

-maxColInRow
This value is used to set the maximum number of Collateral assets to display in a row.
If this parameter is not passed in or is <0, then the default value of 3 will be used


This is an example of how this file could be included into a page:
<c:import url="${jspStoreDir}include/eMarketingSpotDisplay.jsp">
<c:param name="emsName" value="ShoppingCartPage" />
<c:param name="MaxNumDisp" value="8" />
<c:param name="catalogId" value="${WCParam.catalogId}" />
<c:param name="maxItemsInRow" value="4" />
<c:param name="maxColInRow" value="3" />

If the parameters MaxNumDisp, maxItemsInRow, maxColInRow are not provided, default values will be used



This page uses the following commands:

 




This page uses the following beans:

com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean

com.ibm.commerce.marketing.beans.EMarketingSpot


index.jsp

This JSP can be called directly from a URL such as http://<hostname>/webapp/wcs/stores/<storedir>/index.jsp.
index.jsp acquires the storeId from parameters.jspf and finds the stores master catalogId.
This JSP redirects to the TopCategoriesDisplay view to display the store's home page.



This page uses the following beans:

CatalogDataBean

com.ibm.commerce.common.beans.StoreDataBean


parameters.jspf