Corporate Info  |  News  |  Solutions  |  Products  |  Partners  |  Services  |  Events  |  Download  |  How To Buy
	http://www.oracle.com/technology/documentation/index.html   |   Site Map   |   Search   |   PDF Files   |   Contact   |   Glossary   |   What's New
WebLogic Commerce Server Doc Home   |   Tour of the JSP Templates   |   Previous Topic   |   Next Topic   |   Contents   |   Index

In this section of the tour, assume that you want to buy a hammer for a home-improvement project. You have heard of a new e-commerce Web site with a huge selection and low prices, so you decide to visit it. Your trek through the site takes you along the following path:

• New User Roadmap

  Note: Consider opening the New User Roadmap link in a separate browser window; you may want to refer to it frequently during the tour.

• Step 1: Search for Products

• Step 2: Select an Item

• Step 3: View the Shopping Cart

• Step 4: Create a New User Profile

• Step 5: Log In as a Registered User

• Step 6: Choose Shipping Options

• Step 7: Enter Payment Information

• Step 8: Select a Credit Card

• Step 9: Purchase the Item

• Step 10: Review the Order Confirmation

Before starting this section of the tour, review the following maps of the JSP templates (Figure 3-1, Figure 3-2, and Figure 3-3). The arrows in the maps represent navigation options on the site; the darker arrows show the path that this section of the tour describes.

Figure 3-2 JSPs for the Shopping Cart and New User Registration

Figure 3-3 JSPs for Completing the Order

When you first access the site's home page, you notice that you could either browse or search through the product catalog. Because you are looking specifically for a hammer, and because you are unfamiliar with the scope of this new Web site, you decide to use the Quick Look-up box (see Figure 3-4).

To continue the tour...

On the home page, enter hammer in the Quick Look-up box. Then click Find.

When you click Find, the WebLogic Commerce Server search engine queries the product catalog for items with keywords that match hammer and displays the results in searchresults.jsp (see Figure 3-5).

Notice the following features of searchresults.jsp:

• The file's full pathname is
  $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/catalog/searchresults.jsp (UNIX)

• All of the content is dynamically generated. The item's description, price, availability, and URL to its related image come from the item record in the product catalog.

To continue the tour...

Choose a hammer and click Add to Cart.

When you click Add to Cart, WebLogic Commerce Server lists all items you have selected during the current visit to the site in shoppingcart.jsp (see Figure 3-6).

Notice the following features of shoppingcart.jsp:

• The file's full pathname is
  $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/shoppingcart.jsp (UNIX)

• It contains a section of static text that is formatted as HTML.

• The list of items, prices, the subtotal, and all cart-related buttons are dynamically generated based on information in the current Pipeline session (the next topic in this section, Technical Note: Pipeline Components, Pipeline Sessions, and Webflow, describes Pipeline sessions).

For details on the shopping cart, see "Shopping Cart Management Services" in Order Processing Package.

So far this tour has focused on HTML elements and JSP tags, which WebLogic Commerce Server uses to present information in a format that Web browsers can display.

Behind this presentation layer, Pipeline components, Pipeline sessions, and Webflow exchange data with users, apply business logic and process data, maintain state in individual shopping sessions, and direct your users through the site based on a set of context-specific rules. The following list describes each of the mechanisms:

• Pipeline components: Discrete units of server-side business logic, such as logic for calculating tax or committing an order. A succession of Pipeline components, in which one component feeds data to another component, is called a Pipeline. The $WL_COMMERCE_HOME/pipeline.properties file controls the order of Pipeline components in the Pipeline.

• Pipeline sessions: Storage locations for information about the current session (such as the current shopping cart) or more transient data (such as error messages about a customer's most recent input).

• Webflow: Controls the order of JSPs that WebLogic Commerce Server presents to users based on the current state of the Pipeline session. Instead of using individual HTML hypertext links, WebLogic Commerce Server uses a single properties file, $WL_COMMERCE_HOME/webflow.properties, to determine the sequence of pages on your site. Webflow centralizes control of site navigation, making it easy for you to maintain and update the site.

For example, Listing 3-1 shows JSP tags from shoppingcart.jsp that retrieve the contents of the shopping cart from the current Pipeline session. JSP tags that invoke Pipeline components start with the following string:
<pipeline:

<pipeline:getPipelineProperty propertyName="<%=PipelineSessionConstants.SHOPPING_CART%>" returnName="shoppingCart" returnType="com.beasys.commerce.ebusiness.shoppingcart.ShoppingCart"/>

<pipeline:getPipelineProperty propertyName="<%=PipelineSessionConstants.SAVED_SHOPPING_CART%>" returnName="savedShoppingCart" returnType="com.beasys.commerce.ebusiness.shoppingcart.ShoppingCart"/>

For more information on Pipelines and Webflow, see Webflow and Pipeline Management.

Click Check Out.

When you click Check Out from the shopping cart, WebLogic Commerce Server prompts you to log in from login.jsp. Because you are a new user, you must first create a user profile (see Figure 3-7).

• The file's full pathname is
  $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/login.jsp (UNIX)

• It uses innerheader.jsp for the header and innerfooter.jsp for the footer. After a user logs in, most JSPs use innerheader.jsp and innerfoorter.jsp.

• To facilitate browsing the sample templates, it specifies default values in the Username and Password boxes. The sample database includes a user profile for the democustomer user name.

To continue the tour...

Click Create to see the templates for creating a new user profile.

When you click Create on the Log In page, WebLogic Commerce Server prompts you to provide information for your user profile in newuser.jsp (see Figure 3-8 and Figure 3-9).

Notice the following features of the first half of newuser.jsp:

• The file's full pathname is
  $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/register/newuser.jsp (UNIX)

• It uses an input processor to determine if the user completed all required fields (the next topic in this section, Technical Note: Input Processors, describes input processors).

• It contains fields for entering a contact address and a shipping address. Users can enter additional shipping addresses from selectaddress.jsp (see Figure 4-13) or from viewprofile.jsp (see Figure 5-3).

• It includes the following files to provide values for the State and Country lists: $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/includes/states.jsp and $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/includes/countries.jsp

  The State and Country lists are defined in separate JSP files because they are used by several JSP templates.

Technical Note: Input Processors

Input processors are Java classes that handle form submission. Some may perform validation of customer data, but the primary role of an input processor is to store customer data into the Pipeline session for subsequent use by a Pipeline component. Webflow determines whether user input is directed to an input processor and where the input processor directs its output.

For example, Listing 3-2 is an excerpt from newuser.jsp specifying that when a user clicks the Save button, the browser posts data to the Webflow.

<!-- begin form to input customer data. This form posts to the Webflow Advisor a "button(save)" event from origin "newuser.jsp" -->

<form method="post" action="<%=WebflowJSPHelper.createWebflowURL(pageContext, "newuser.jsp", "button(save)", false)%>">

<input type=hidden name=origin value="newuser.jsp">

<input type=hidden name=event value="button(save)">

Listing 3-3 shows the excerpt from webflow.properties that directs information posted from newuser.jsp. In the excerpt, Webflow sends information to the newuser.CustomerProfile.inputprocessor; then it directs the results from the CustomerProfile input processor to the CustomerProfile Pipeline. If the input processor detects an error, it redisplays newuser.jsp and populates it with data from the current Pipeline session.

# Process the data from the form

newuser.jsp.button(save)=newuser.CustomerProfile.inputprocessor

# And send it off to create the user

newuser.CustomerProfile.inputprocessor.success=CustomerProfile.pipeline

...

# On an error, bring them back to the newuser.jsp form. 
# It will be redisplayed with their old data and error messages added in.

newuser.CustomerProfile.inputprocessor.exception(InvalidInputException)=
commerce/register/newuser.jsp

CustomerProfile.pipeline.exception(PipelineFatalException)=commerce/register/
newuser.jsp

For a description of input processors that WebLogic Commerce Server provides, refer to the following documents:

• Product Catalog Management

• Registration and User Processing Package

• Order Processing Package

More Features of newuser.jsp (Part 2 of 2)

Notice the following features of the second half of newuser.jsp:

• It includes newcctemplate.jsp, which contains fields for new credit card information.

  The values for the Credit Card Type and Expiration Date lists are defined in newcctemplate.jsp because newcctemplate.jsp is the only template that uses them. The values for the State and Country lists are defined in separate JSP files because they are used by several JSP templates.

• It does not require you to enter payment information to set up your user profile.

• The maximum number of characters allowed for user names and passwords is set in the JSP file as 50. The sample JSP templates do not impose other restrictions, such as required character types or disallowed character types. If you want to impose such restrictions, you must set up your own field validator, possibly in the form of an input processor.

To continue the tour...

Complete the required fields and click Save.

When you click Save, WebLogic Commerce Server prompts you to log in from login.jsp (see Figure 3-10).

For a description of login.jsp, see Features of login.jsp.

Type the user name and password you entered with your new user profile. Then click Log In.

When you click Log In, WebLogic Commerce Server displays successfullogin.jsp (see Figure 3-11).

Notice the following features of successfullogin.jsp:

• The file's full pathname is
  $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/user/successfullogin.jsp (UNIX)

• It displays only when a user creates a new user profile, confirming that the user is now registered and authenticated.

• It displays the checkout button only if there are items in the shopping cart for the current Pipeline session. Listing 3-4 shows the JSP tags that query the Pipeline session and the Java scriptlets that evaluate the results of the query and toggle the checkout button.

  Listing 3-4 Displaying the Checkout Button

  ---

  <!-- Get the shopping cart so we know if checkout is an option -->

  <pipeline:getPipelineProperty propertyName="<%=PipelineSessionConstants.SHOPPING_CART%>" returnName="shoppingCart" returnType="com.beasys.commerce.ebusiness.shoppingcart.ShoppingCart"/>

  <p>
  You have successfully logged in. 
  </p>
  <p>
  You may now go to your 

  <a href="<%=WebflowJSPHelper.createWebflowURL(pageContext, "successfullogin.jsp",
  "link(shoppingcart)", true) %>">shopping cart</a>,

  <% if (shoppingCart != null && shoppingCart.isEmpty() == false) { %>
  <a href="<%=WebflowJSPHelper.createWebflowURL(pageContext, "successfullogin.jsp",
  "button(checkout)", true) %>">checkout</a>, 
  <% } %>

  or return to the 
  <a href="<%=WebflowJSPHelper.createWebflowURL(pageContext, "successfullogin.jsp",
  "link(home)", true) %>">main page</a> to continue shopping.
  </p>

  ---

To continue the tour...

Click the Checkout button.

When you click Checkout, WebLogic Commerce Server starts the checkout process by displaying shipping options in shipping.jsp (see Figure 3-12).

Notice the following features of shipping.jsp:

• The file's full pathname is
  $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/order/shipping.jsp (UNIX)

• It uses Pipelines JSP tags to display the shipping methods that are defined in your database. To enhance performance, WebLogic Commerce Server caches the list of methods instead of accessing the database each time the JSP tags request the data.

• It uses HTML to implement the Ship All At Once or As Available? radio buttons and the Special Instructions input box.

To continue the tour...

1. Select shipping options. You may also enter a comment in the Special Instructions box.

2. Click Continue.

When you click Continue, WebLogic Commerce Server displays your shipping addresses in selectaddress.jsp (see Figure 3-13).

Notice the following features of selectaddress.jsp:

• The file's full pathname is
  $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/order/selectaddress.jsp (UNIX)

• It uses Java scriptlets to iterate through the list of shipping addresses in the user profile (see Listing 3-5).

• It invokes the Taxation Service, a WebLogic Commerce Server implementation of business logic and presentation logic that interfaces with TAXWARE to determine the taxes that are due. For information about TAXWARE, see About TAXWARE. For more information about the Taxation Service, see "Taxation Services" in Order Processing Package.

  Listing 3-5 Java Scriptlets in selectaddress.jsp

  ---

  <% Iterator iterator = shippingAddressMap.keySet().iterator();
  while(iterator.hasNext()) {
     String addressKey = (String)iterator.next();
     Address shippingAddress = (Address)shippingAddressMap.get(addressKey);%>

  <table>

    <tr>
    <td><%= shippingAddress.getStreet1() %></td>
    </tr>

    <tr>
    <td><b>Country <%= shippingAddress.getCounty() %></b></td>
    </tr>

  </table>

  <%
    }
  %>

  ---

To continue the tour...

Click Use.

When you click Use, WebLogic Commerce Server displays payment.jsp, which lists any credit cards that are in your user profile (see Figure 3-14).

Notice the following features of payment.jsp:

• The file's full pathname is
  $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/order/payment.jsp (UNIX)

• Because you did not add payment information when you set up your user profile, your only option on this page is to add credit card information.

To continue the tour...

Click Add Card.

When you click Add Card, WebLogic Commerce Server prompts you to enter payment information in paymentnewcc.jsp (see Figure 3-15).

Notice the following features of paymentnewcc.jsp:

• The file's full pathname is
  $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/order/paymentnewcc.jsp (UNIX)

• This page is similar to $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/user/profilenewcc.jsp and $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/register/newuser.jsp.

  All three JSP files use an include file, $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/includes/newcctemplate.jsp, to define the credit card input fields. For more information about template include files, see the next topic in this section, Technical Note: Templates Included Within Templates.

• Clicking Save updates the user profile.

Technical Note: Templates Included Within Templates

Rather than repeating input fields and other information across several files, the WebLogic Commerce Server JSP templates assign re-used JSP tags and HTML elements to a set of include files, which are, in turn, JSP templates that you can use to develop your site. For example, paymentnewcc.jsp (described in the previous section), profilenewcc.jsp, and newuser.jsp are parent JSP pages that include newcctemplate.jsp as a child page to provide consistent input fields for credit card information. You can include newcctemplate.jsp in other JSP files that you create.

Why doesn't Webflow specify newcctemplate.jsp in all locations that request credit card information instead of using three files, paymentnewcc.jsp, profilenewcc.jsp, and newuser.jsp? Webflow uses the three parent JSP pages to determine a user's context and to determine which pages to display after a user enters new credit card information. For example, Figure 3-16 shows that after a user completes paymentnewcc.jsp, Webflow displays payment.jsp; after a user completes profilenewcc.jsp, Webflow displays viewprofile.jsp, and after a user completes newuser.jsp, login.jsp is displayed.

For a list of include files and the JSP templates that use them, see Product Catalog Management and Order Processing Package.

1. Enter information for a credit card.

   If you have enabled the CyberCash integration, you can use any of the following credit card types and numbers to test or demonstrate the integration:

   • VISA: 4111111111111111 (one four and 15 ones)

   • MasterCard: 5555555555554444 (12 fives and four fours)

   • Amex: 378282246310005

   • Discover: 6011111111111117

     For more information about the CyberCash integration, see About CyberCash.

     If you have not enabled the CyberCash integration, you can use the numbers and card types in the previous list or enter 16-18 characters for any card type. For the Card Number box, the sample JSP templates validate only the number of characters that you enter.

2. Complete the remaining required fields and click Save.

When you click Save in paymentnewcc.jsp, WebLogic Commerce Server displays your newly added credit card information in payment.jsp (see Figure 3-17).

Notice the following features of payment.jsp:

• User Management JSP tags generate the credit card list based on your user profile. Earlier in the tour when you accessed payment.jsp for the first time (see Figure 3-14), the User Management JSP tags returned zero credit card definitions from your user profile.

To continue the tour...

Click Use.

When you click Use in payment.jsp, WebLogic Commerce Server displays checkout.jsp, from which you review the tax information and complete the purchase.

Notice the following features of checkout.jsp:

• The file's full pathname is
  $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/order/checkout.jsp (UNIX)

• It uses JSP tags to gather and display information from the Pipeline, including the tax information that the Taxation Service calculates.

• Clicking Complete Purchase invokes the Payment Service, a WebLogic Commerce Server implementation of business logic that processes payments. If you have enabled the CyberCase integration, the Payment Service sends your credit card information and transaction amount to CyberCash for verification. If CyberCash verifies the card and purchase amount, WebLogic Commerce Server invokes the Taxation Service, which appends to your TAXWARE log file for record keeping. For more information about the Payment Service, see "Payment Services" in Order Processing Package.

To continue the tour...

Click Complete Purchase.

When you click Complete Purchase, WebLogic Commerce Server completes the purchase and displays the confirmation number in confirmorder.jsp (see Figure 3-19).

Notice the following features of confirmorder.jsp:

• The file's full pathname is
  $WL_COMMERCE_HOME/server/webapps/wlcs/commerce/order/confirmorder.jsp
  (UNIX)

• The Pipeline mechanism generates the confirmation number.

• Pipeline JSP tags gather and display the information on this page.

To continue the tour...

This concludes the tour for new users. To continue the tour of the JSP templates, click Home in the navigation bar and go to the next section, Registered User Buys a Product.