The Product Catalog JSP Templates

 

The Commerce services included in the WebLogic Portal product suite provide JavaServer Page (JSP) templates and JSP tags that implement commonly used Web-based product catalog features. The Product Catalog JSP templates allow your visitors to search for product items or browse through categories to locate items; the JSP tags are used to implement this functionality.

When you click the Add to Cart button on the JSPs that provide item details, the default Webflow for the Commerce services (wlcs) Web application passes data about the selected product items to the order management JSPs. For information about the order processing JSPs, see the Guide to Managing Purchases and Processing Orders.

This topic includes the following sections:

• Introduction

  • Accessing the Product Catalog JavaServer Page (JSP) Templates

  • On Which JavaServer Page Will My Customers Start?

  • Sample Path Through the Product Catalog JSP Templates

• JavaServer Pages (JSPs)

  • main.jsp Template

  • browse.jsp Template

  • details.jsp Template

  • search.jsp

  • searchresults.jsp

• Query-Based Search Syntax

  • Using Comparison Operators to Construct Queries

  • Searchable Catalog Attributes

  • Controlling the Number of Search Results

• Input Processors

  • CatalogIP

  • ExpressionSearchIP

  • GetCategoryIP

  • GetProductItemIP

  • KeywordSearchIP

  • MoveAttributeIP

  • RemoveAttributeIP

• Pipeline Components

  • CatalogPC

  • GetAncestorsPC

  • GetCategoryPC

  • GetParentPC

  • GetProductItemPC

  • GetProductItemsPC

  • GetSubcategoriesPC

  • MoveAttributePC

  • PriceShoppingCartPC

  • RemoveAttributePC

  • SearchPC

Note: In this topic, the environment variable PORTAL_HOME is used to represent the directory in which you installed the WebLogic Portal software.

 

---

Introduction

The JavaServer Page (JSP) templates and JSP tags included in the Commerce services allow you to easily customize the presentation of the Product Catalog. Some important points about the Product Catalog JSP templates (that you should be aware of before proceeding in this topic) are as follows:

• The names of the JSPs for categories and product items are stored in the database as attributes of the categories and items. (See The Product Catalog Database Schema, for information about the DISPLAY_JSP_URL column in the WLCS_CATEGORY database table, and the SUM_DISPLAY_JSP_URL column [a pointer to the item's summary page] and the DET_DISPLAY_JSP_URL column [a pointer to the item's detail page] in the WLCS_PROD_ITEM database table.)

• The Product Catalog integrates with the Webflow mechanism, which automatically selects the appropriate JSP for displaying a particular category or product item. The Webflow is set by elements in a centralized Webflow configuration file, as explained in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

• JSP tag libraries allow you to easily retrieve the attributes of items and categories in the Product Catalog. You can then format these attributes using HTML tags. Any HTML editor can be used to create custom layouts. You can also include custom Java code within the JSPs to display categories and items. For more information about the Product Catalog JSP tags, see Product Catalog JSP Tag Library Reference.

The remainder of this introduction provides you with information relevant to viewing the Product Catalog and learning how it functions. Once you understand how the Product Catalog works, you may want to use it as a starting point for building your own product catalog.

Accessing the Product Catalog JavaServer Page (JSP) Templates

The Commerce services JSP templates and all the supporting Java packages that comprise the Product Catalog are configured to run as a Web application on the WebLogic Server. Therefore, you can access the sample Product Catalog (as well as the other JSP templates that comprise the order fulfillment and customer services) by accessing the wlcs Web application. For more information about how to access Web applications, see the "URLs for Accessing Web Applications" and "The Reference Web Applications, Enterprise Applications, and Domain" topics in the WebLogic Portal Architectural Overview documentation.

On Which JavaServer Page Will My Customers Start?

Because the wlcs Web application utilizes the Webflow mechanism, there is some behind-the-scenes processing taking place to direct customers to the initial Product Catalog JavaServer Page (JSP). Detailed information on this processing can be located in Understanding How Webflow Is Invoked From a URL in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Sample Path Through the Product Catalog JSP Templates

The Product Catalog includes a number of JSP templates that span the start-to-finish experience for a Web site customer who is shopping on your site. There are several sequence paths through the system; the following list outlines one possible path.

1. If the customer has previously registered and logged in, display a home page that welcomes the customer, and include links to the customer's Order History and Payment History. Otherwise, just display a generic home page.

2. Search for or browse product items in the catalog.

3. Add one or more items to a shopping cart.

4. Enter or update the customer's profile information, such as their default shipping address, default credit card billing address, and credit card number (encrypted).

5. Checkout.

6. Review an order.

7. View a confirmation of an order.

8. Optionally check the status of an order.

 

---

JavaServer Pages (JSPs)

The wlcs Web application contains a number of JavaServer Pages (JSPs) that allow your customers to view a catalog's categories and product items. You can use these pages in their current form, or adapt them to meet your specific needs. This section describes each page in detail.

Note: For a description of the complete set of JSPs used in the Commerce services (wlcs) Web application and a listing of their locations in the directory structure, see the Summary of JSP Templates documentation.

Figure 5-1 illustrates the JSP templates that participate in the Product Catalog portion of the Webflow. Notice that the Product Catalog JSPs belong to the sampleapp_main and sampleapp_search Webflow namespaces.

Figure 5-1 Flow of Catalog JSP Templates

 

main.jsp Template

The main.jsp template is the default home page for the Product Catalog. Depending on whether or not customers are logged in, the main.jsp template displays different content in the left-side bar.

Sample Browser View

Figure 5-2 shows a version of the main.jsp template.

Figure 5-2 The main.jsp Template Before Customer Login

 
 

The numbers in the following list refer to the numbered regions in the figure:

1. The admin banner is created from an import of the admin.inc template. The banner provides links to the current template's About information, the JSP template index, and the Administration Tools page. The import call is:

   <%@ include file="/commerce/includes/admin.inc" %>

   You should remove the admin.inc template from the production pages before you move them to your live server.

2. The page header is created from an import of the header.inc template. This is standard across most of the JSP templates included with the Commerce services. The import call is:

   <%@ include file="/commerce/includes/header.inc" %>

   The header.inc file creates the top banner and reserves space for the left-side column. The contents of the left-side column are determined by other processing (see item 4 in this list).

3. The content in region 3 on the main.jsp template is generated by a series of Webflow JSP tags that obtain the top category (in this case, the root category for the entire catalog) and use it to obtain all of its subcategories. Then, the Catalog and Webflow JSP tags display each category name in a hyperlinked list.

4. The content shown in region 4 depends on whether the customer is logged in. (In Figure 5-2, the customer had not logged in.) The leftside.inc template is always included into the main.jsp template. The include statement is:

   <%@ include file="/commerce/includes/leftside.inc" %>

   If the customer is logged in, the customer is considered a registered customer, welcomed with a greeting, and presented with links to view their profile, order history, and payment history. In addition, the customer can choose to Logout of their account. Figure 5-3 shows only the left-side column when a customer is logged in.

   Figure 5-3 Left-Column of main.jsp When the Customer Is Logged In

   
    

5. The main.jsp template's content in region 5 contains the included footer.inc template. The include statement is:

   <%@ include file="/commerce/includes/footer.inc" %>

   The footer.inc file consists of the horizontal footer at the bottom of the page.

Location in the Directory Structure

You can find the main.jsp file at the following location, where PORTAL_HOME is the directory in which you installed WebLogic Portal:

%PORTAL_HOME%\applications\wlcsApp\wlcs\commerce\main.jsp (Windows)
$PORTAL_HOME/applications/wlcsApps/wlcs/commerce/main.jsp (UNIX)

Tag Library Imports

The main.jsp template uses Webflow, Catalog, and the WebLogic Personalization Server's User Management, Personalization, E-Commerce Services, and Content Management JSP tags. Therefore, the template includes the following JSP tag libraries:

<%@ taglib uri="webflow.tld" prefix="webflow" %>
<%@ taglib uri="cat.tld" prefix="catalog" %>
<%@ taglib uri="um.tld" prefix="um" %>
<%@ taglib uri="pz.tld" prefix="pz" %>
<%@ taglib uri="es.tld" prefix="es" %>
<%@ taglib uri="cm.tld" prefix="cm" %>

Notes: For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation. For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld For more information on the WebLogic Personalization Server's JSP tags, see Personalization Server JSP Tag Library Reference in the Guide to Building Personalized Applications documentation.

These files reside in the following directory for the Commerce services (wlcs) Web application:

%PORTAL_HOME%\applications\wlcsApp\wlcs\WEB-INF (Windows)
$PORTAL_HOME/applications/wlcsApp/wlcs/WEB-INF (UNIX)

Java Package Imports

The main.jsp template uses Java classes in the following packages and therefore includes these import statements:

<%@ page import="com.beasys.commerce.webflow.HttpRequestConstants" %>
<%@ page import="com.beasys.commerce.webflow.PipelineSessionConstants" %>
<%@ page import="com.beasys.commerce.ebusiness.catalog.Category" %>
<%@ page import="com.beasys.commerce.ebusiness.catalog.ViewIterator" %>
<%@ page import="com.bea.p13n.content.ContentHelper"%>

Location in the Default Webflow

The main.jsp template is the first page you or your customers will see upon starting the Commerce services (wlcs) Web application, and is part of the Webflow's sampleapp_main namespace. From this page, customers can browse the store catalog by clicking on a link to a particular category (which loads the browse.jsp template). Customers can also enter keywords and click the Find button to perform a Quick Look-up of a particular product item (which loads the searchresults.jsp template). If the customer is logged into the site, the customer can also choose to log out (which loads a different version of the main.jsp template), view their customer profile (which loads the viewprofile.jsp template), view their order history (which loads the orderhistory.jsp template), or view their payment history (which loads the paymenthistory.jsp template).

Note: For more information about the default Webflow, see Figure 5-1.

Included JSP Templates

The following JSP templates are included into the main.jsp template:

• admin.inc, which creates the admin banner that provides links to the current template's About information, the JSP template index, and the Administration Tools page.

• stylesheet.inc, which is a cascading stylesheet that defines global paragraph and text styles for the site.

• header.inc, which creates the top banner and reserves space for the left-side column. The contents of the left-side column are determined by processing in the included leftside.inc.

• leftside.inc, which provides a keyword-based search tool for finding product items via keywords that have already been assigned, and additional links if customers are logged in.

• footer.inc, which creates a horizontal footer at the bottom of the page.

Events

Every time a customer clicks a link or a button on the main.jsp template (or those displayed by the included file leftside.inc ), it is considered an event. Each event triggers a particular response in the default Webflow that allows the customer to continue. While this response can be to load another JSP, it is usually the case that an Input Processor and/or Pipeline is invoked first. Table 5-1 provides information about these events and the Webflow response(s) they invoke.

Note: Descriptions are provided for Pipelines only.

Table 5-1 main.jsp Events

Event	Webflow Response(s)	Description
link.browse	browseCategory (IP) moveSiblingResults (IP)	--
	getBrowseDetails	Contains GetCategoryPC, GetParentPC, GetSubcategoriesPC, MoveAttributePC, GetCategoryPC2, GetAncestorsPC, GetSubcategoriesPC2, GetProductItemsPC and is not transactional.
link.quicksearch	keywordSearchIP	--
	keywordSearch	Contains SearchPC and is not transactional.
link.viewCustomerProfile	No business logic required. Loads viewprofile.jsp	--
link.logout	LogoutCustomerIP	--
link.viewOrderHistory	refreshOrderHistory	Contains RefreshOrderHistoryPC and is not transactional.
link.viewPaymentHistory	refreshPaymentHistory	Contains RefreshPaymentHistory and is not transactional.

 

Notes: For more information about individual Input Processors, see Input Processors. For more information about individual Pipeline Components, see Pipeline Components.

Dynamic Data Display

One purpose of the main.jsp template is to decide which version of the left column to display (the one with just the Quick Look-up or the one with links to customer-specific data). To accomplish this, the included header.inc file first obtains the customer's profile, which may be null if the customer is not logged in. Listing 5-1 illustrates how a customer profile is obtained using the getProfile User Management JSP tag in the included header.inc file.

Listing 5-1 Obtaining the Customer Profile

<%-- Get the username --%>
<%-- if the user is not null, get the customer's profile --%>

<%
if (request.getRemoteUser() != null) {
%>

<um:getProfile profileKey="<%=request.getRemoteUser()%>" 
 profileType="WLCS_Customer" />

<% } %>

Note: For more information on the WebLogic Personalization Server's User Management JSP tags, see Personalization Server JSP Tag Library Reference in the Guide to Building Personalized Applications documentation.

Next, the included leftside.inc file attempts to obtain the customer's username from the customer profile. If the customer's username is not equal to null, the additional links for the left column are displayed, as shown in Listing 5-2. Otherwise, just the Quick Look-up is shown.

Listing 5-2 Displaying Additional Links Based on Customer's Username

<%-- Only show links to view order and payment history pages if user is logged in. --%>

<%-- Get the username. The customer 's profile should have already been loaded --%>
<%-- obtained from the um:getProfile tag in the header.inc --%>

<% 
if (request.getRemoteUser() != null) {   
%>

<p><b>Welcome<br>
<%=request.getRemoteUser() %>

<um:getPropertyAsString propertySet="CustomerProperties" 
 propertyName="firstName" /> 
<um:getPropertyAsString propertySet="CustomerProperties" 
 propertyName="lastName" /></b></p>

<p>&nbsp;&nbsp;
<a href="<webflow:createWebflowURL namespace="sampleapp_user" 
 origin="main.jsp" event="link.viewCustomerProfile" />">View 
 Profile</a></p>

<p>&nbsp;&nbsp;
<a href="<webflow:createWebflowURL namespace="sampleapp_main" 
 origin="main.jsp" event="link.logout" />">Logout</a></p>

<div class="mid" align="center">
   <img src="<webflow:createResourceURL 
    resource="/commerce/images/left_rule.gif" />" width="120" 
    height="14" align="absmiddle"></div>

<p><b>View History</b></p>

<p>&nbsp;&nbsp;
<a href="<webflow:createWebflowURL namespace="sampleapp_order" 
 origin="main.jsp" event="link.viewOrderHistory" 
 />">Orders</a></p>

<p>&nbsp;&nbsp;
<a href="<webflow:createWebflowURL namespace="sampleapp_order" 
 origin="main.jsp" event="link.viewPaymentHistory" 
 />">Payments</a></p>

<div class="mid" align="center">
   <img src="<webflow:createResourceURL 
    resource="/commerce/images/left_rule.gif" />" width="120" 
    height="14" align="absmiddle"></div>

<% } %>

<%-- Only display Quick Look-up links for pages where FullNav is set to "true" --%>

<% if (pageContext.getAttribute("FullNav").equals("true")) { %>
<%-- Add the Quick Look-up section --%>

<p><b>Quick Look-up:</b></p>
<p>&nbsp;&nbsp;Enter keywords</p>

<%-- The optional CATALOG_VIEW_SIZE parameter allows you to specify the number of items per "view" of results --%>

<input type=hidden name="<%= 
 HttpRequestConstants.CATALOG_VIEW_SIZE %>" value="10">

<p>&nbsp;&nbsp; 

<input type="text" name="<%= 
 HttpRequestConstants.CATALOG_SEARCH_STRING %>" size="9" 
 maxlength="50">

<br>&nbsp;&nbsp; 

<input type="image" value="Find" border="0" 
 src="<webflow:createResourceURL 
 resource="/commerce/images/btn_find.gif" />"></p>

<div class="mid" align="center">
   <img src="<webflow:createResourceURL 
    resource="/commerce/images/left_rule.gif" />" width="120" 
    height="14" align="absmiddle"></div>

<% } %>

<%-- End of FullNav conditional content --%>

Notes: For more information on the WebLogic Personalization Server's User Management JSP tags, see Personalization Server JSP Tag Reference in the Guide to Building Personalized Applications documentation. For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

However, the primary purpose of the main.jsp template is to dynamically display Product Catalog data by category. This is accomplished using a combination of Webflow and Catalog JSP tags.

First, the getProperty Webflow JSP tag obtains the CATALOG_CATEGORY and CATALOG_CATEGORIES properties from the Pipeline Session. Table 5-2 provides more detailed information on these properties.

Table 5-2 main.jsp Pipeline Session Properties

Property	Type	Description
PipelineSessionConstants.CATALOG_CATEGORY	com.beasys.commerce.ebusiness.catalog.Category	Contains the root category for the Product Catalog.
PipelineSessionConstants .CATALOG_CATEGORIES	com.beasys.commerce.ebusiness.catalog.ViewIterator	Contains the top-level categories for the Product Catalog.

 

Listing 5-3 illustrates how these properties are obtained from the Pipeline Session using the getProperty Webflow JSP tag.

Listing 5-3 Obtaining the CATALOG_CATEGORY and CATALOG_CATEGORIES Properties

<%-- Get the top category from the PipelineSession. --%>

<webflow:getProperty id="topCategory" 
 property="<%=PipelineSessionConstants.CATALOG_CATEGORY%>" 
 type="com.beasys.commerce.ebusiness.catalog.Category" 
 scope="request" namespace="sampleapp_main" />

<%-- Get the subcategories of the top category from the PipelineSession. --%>

<webflow:getProperty id="subcategories" 
 property="<%=PipelineSessionConstants.CATALOG_CATEGORIES%>" 
 type="com.beasys.commerce.ebusiness.catalog.ViewIterator" 
 scope="request" namespace="sampleapp_main" />

Note: For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Next, a string containing common browse parameters for the page is created, as shown in Listing 5-4. These parameters are used to establish context for the page (that is, a knowledge of previous activity) and provide the Pipelines with appropriate information during their subsequent executions.

Listing 5-4 Creating a String with Common Browse Parameters

<p class="head1">Store Catalog</p>
<ul type="square">

<%-- Declare a String containing common browse parameters --%>

<%! static final String commonParameters = 
 HttpRequestConstants.CATALOG_SOURCE_KEY + "=" + 
 PipelineSessionConstants.CATALOG_CATEGORIES + "&" + 
 HttpRequestConstants.CATALOG_DESTINATION_KEY + "=wlcs_siblings&"; %>

Lastly, the iterateViewIterator Catalog JSP tag is used to iterate through all the categories (one at a time). The context for the page is captured by appending values to the previously established browse parameters, and the getProperty Catalog JSP tag is used to list the name of each category on the main.jsp template, as shown in Listing 5-5.

Listing 5-5 Displaying the Contents of the Product Catalog

<catalog:iterateViewIterator iterator="<%= subcategories %>" 
 id="currentCategory" 
 returnType="com.beasys.commerce.ebusiness.catalog.Category">

   <% String browseParameters = commonParameters + 
      HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
      java.net.URLEncoder.encode(currentCategory.getKey().
      getIdentifier()); %>

   <li>
	<a href="<webflow:createWebflowURL event="link.browse"  
	 namespace="sampleapp_main" 
	 extraParams="<%=browseParameters%>"/>">
	 <b><catalog:getProperty object="<%= currentCategory %>" 
	 propertyName="Name"/></b>
	</a>

	<br>

</catalog:iterateViewIterator>

Notes: For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld. For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Form Field Specification

No form fields are used in the main.jsp template.

browse.jsp Template

In the hierarchical Product Catalog, the browse.jsp template can take on two different forms, both of which are used by customers to browse for product items. These forms are as follows:

• The Product Catalog reads a unique category.jsp template from the database for the current category being browsed, and includes it into the browse.jsp template. The category.jsp presents the current level of available subcategories as hyperlinks. Additionally, a hyperlinked list of sibling categories is made available above the main category. An ancestor category navigation bar (such as Home -> Power Tools) is also displayed at the top of the page. Figure 5-4 shows a screen shot of this browse.jsp template form.

  Figure 5-4 browse.jsp Template - Power Tools Subcategories

  
   

• Once a customer reaches the end of the catalog hierarchy (that is, when a category contains product items instead of more subcategories), the catalog reads the appropriate number of itemsummary.jsp templates from the database and includes them into the category.jsp template. In this form of the browse.jsp template, the itemsummary.jsp templates replace the hyperlinked list of categories. A list of sibling categories still displays the current category (highlighted), and the ancestor category navigation bar is also shown at the top of the page. Figure 5-5 illustrates this nesting of JSP templates within the browse.jsp template.

  Figure 5-5 Hierarchical Relationship of browse.jsp and Other JSPs

  
   

Figure 5-6 shows a screen shot of this browse.jsp template form, with one included itemsummary.jsp.

Figure 5-6 browse.jsp Template - Power Tools -> Drills Category with Item Summary Display

 

Note: Each item in the catalog can be assigned a different item summary JSP, allowing you to customize the layout for each type of item. This assignment can be made on the catalog's administration screen. For more information, see Determining How Categories and Items are Displayed to Web Site Visitors.

Sample Browser View

Figure 5-7 shows a version of a browse.jsp template.

Figure 5-7 The browse.jsp Template

 
 

The numbers in the following list refer to the numbered regions in the figure:

1. The admin banner is created from an import of the admin.inc template. The banner provides links to the current template's About information, the JSP template index, and the Administration Tools page. The import call is:

   <%@ include file="/commerce/includes/admin.inc" %>

   You should remove the admin.inc template from the production pages before you move them to your live server.

2. The page header is created from an import of the header.inc template. This is standard across most of the JSP templates provided by Commerce services. The import call is:

   <%@ include file="/commerce/includes/header.inc" %>

   The header.inc file creates the top banner and reserves space for the left-side column. The contents of the left-side column are determined by other processing (see main.jsp Template for more information).

3. Region 3 of the browse.jsp template contains the leftside.inc template that is included. This template provides a keyword-search feature. The include statement is:

   <%@ include file="/commerce/includes/leftside.inc" %>

4. Region 4 of the browse.jsp template includes navigation.jsp, which builds an ancestor category navigation bar for the catalog's categories from the top-level Home category down to the current category. The call to include this JSP is:

   <jsp:include page="/commerce/catalog/includes/navigation.jsp" flush="true"/>

5. Region 5 of the browse.jsp template contains the results of processing that checks for sibling categories and displays them with hyperlinks to those categories.

6. Region 6 of the browse.jsp template shows the generated results of processing with the Webflow mechanism, which located the values for this category (presented in the included category.jsp template). The category.jsp template, in turn, obtains the values that return the item summary data (displayed by the included itemsummary.jsp templates) for each product item in this category.

7. Region 7 of the browse.jsp template contains the included footer.inc template. The include statement is:

   <%@ include file="/commerce/includes/footer.inc" %>

   The footer.inc file consists of the horizontal footer at the bottom of the page.

Location in the Directory Structure

You can find the browse.jsp file at the following location, where PORTAL_HOME is the directory in which you installed WebLogic Portal:

%PORTAL_HOME%\applications\wlcsApp\wlcs\commerce\catalog\
browse.jsp (Windows)
$PORTAL_HOME/applications/wlcsApp/wlcs/commerce/catalog/
browse.jsp (UNIX)

Tag Library Imports

The browse.jsp template uses Webflow and Catalog JSP tags. Therefore, the template includes the following JSP tag libraries:

<%@ taglib uri="webflow.tld" prefix="webflow" %>
<%@ taglib uri="cat.tld" prefix="catalog" %>

Notes: For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation. For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld

These files reside in the following directory for the Commerce services (wlcs) Web application:

%PORTAL_HOME%\applications\wlcsApp\wlcs\WEB-INF (Windows)
$PORTAL_HOME/applications/wlcsApp/wlcs\WEB-INF (UNIX)

Java Package Imports

The browse.jsp template uses Java classes in the following packages and therefore includes these import statements:

<%@ page import="com.beasys.commerce.ebusiness.catalog.*" %>
<%@ page import="com.beasys.commerce.webflow.HttpRequestConstants" %>
<%@ page import="com.beasys.commerce.webflow.PipelineSessionConstants" %>

Location in the Default Webflow

The browse.jsp template is displayed (with the included category.jsp template) when a customer clicks on a link for one of the categories shown on the main.jsp template. The browse.jsp template is part of the sampleapp_main namespace, and is redisplayed (with different content using the included category.jsp template) each time a customer clicks on a subcategory link. It is also displayed when a customer selects a sibling link from the list above the category. The browse.jsp continues to be displayed until the customer arrives at item summaries (displayed by the category.jsp template's included itemsummary.jsp templates). From there, the customer can choose to view more details about an item (which loads the details.jsp template), or add the item to their shopping cart (which loads the shoppingcart.jsp template).

Customers can also still enter keywords and click the Find button to perform a Quick Look-up of a particular product item or category (which loads the searchresults.jsp template). If the customer is logged into the site, the customer can also choose to log out (which loads the generic version of the main.jsp template), view their customer profile (which loads the viewprofile.jsp template), view their order history (which loads the orderhistory.jsp template), or view their payment history (which loads the paymenthistory.jsp template).

Note: For more information about the default Webflow, see Figure 5-1.

Included JSP Templates

The following JSP templates are included into the browse.jsp template:

• admin.inc, which creates the admin banner that provides links to the current template's About information, the JSP template index, and the Administration Tools page.

• stylesheet.inc, which is a cascading stylesheet that defines global paragraph and text styles for the site.

• header.inc, which creates the top banner and reserves space for the left-side column. The contents of the left-side column are determined by processing in the included leftside.inc.

• leftside.inc, which provides a keyword-based search tool for finding product items via keywords that have already been assigned, and additional links if customers are logged in.

• navigation.jsp, which builds a hierarchical browse list for the catalog's categories from the top-level Home category down to the current category. For more information about the navigation.jsp template, see About the Included navigation.jsp Template.

• category.jsp, which displays links to the current category's subcategories, and also includes the itemsummary.jsp template (if particular items are available). For more details about the category.jsp template, see About the Included category.jsp Template. For more details about the itemsummary.jsp template, see About the Included itemsummary.jsp Template.

• footer.inc, which creates a horizontal footer at the bottom of the page.

About the Included navigation.jsp Template

The navigation.jsp template (included in the browse.jsp template) is responsible for generating the ancestor category navigation bar that is shown at the top of the page. The navigation.jsp template utilizes Webflow, Catalog, and the WebLogic Personalization Server's Utility JSP tags to generate this content.

First, the getProperty Webflow JSP tag is used to obtain the current category (that is, the CATALOG_CATEGORY property) from the Pipeline Session, as shown in Listing 5-6.

Listing 5-6 Obtaining the CATALOG_CATEGORY Property

<webflow:getProperty id="category" 
 property="<%=PipelineSessionConstants.CATALOG_CATEGORY%>" 
 type="com.beasys.commerce.ebusiness.catalog.Category" 
 scope="request" namespace="sampleapp_main" />

Note: For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Next, the <es> JSP tag (one of the WebLogic Personalization Server Utility JSP tags) is used to ensure that the conditions under which the ancestor category navigation bar is displayed are appropriate. If so, the category's ancestors are obtained from the Pipeline Session (again using the getProperty Webflow JSP tag).

Listing 5-7 Establishing Conditional Display of the Navigation Bar and Obtaining the Category's Ancestors

<%-- Only output the navigation bar if a current category exists in the PipelineSession --%>

<es:notNull item="<%= category %>">

<%-- Get the category's ancestors from the PipelineSession --%>

<webflow:getProperty id="ancestors" 
 property="<%=PipelineSessionConstants.CATALOG_ANCESTORS%>" 
 type="com.beasys.commerce.ebusiness.catalog.Category[]" 
 scope="request" namespace="sampleapp_main" />

Notes: For more information on the WebLogic Personalization Server's Utility JSP tags, see Personalization Server JSP Tag Library Reference in the Guide to Building Personalized Applications documentation. For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Browse parameters for the navigation.jsp template are concatenated into a single string, and a link is created for each category ancestor. These parameters are used to establish context for the page (that is, a knowledge of previous activity) and provide the Pipelines with appropriate information during their subsequent executions. In the case of the last ancestor, a link to the main catalog page is also created. This is accomplished with the <es> WebLogic Personalization Server Utility JSP tag and the getProperty Catalog JSP tag, as shown in Listing 5-8.

Listing 5-8 Generating the Hierarchical Category Navigation Bar

<%-- Declare a String containing common browse parameters --%>

<%! static final String commonParameters = 
 HttpRequestConstants.CATALOG_SOURCE_KEY + "=" + 
 PipelineSessionConstants.CATALOG_CATEGORIES + "&" +
 HttpRequestConstants.CATALOG_DESTINATION_KEY + "=wlcs_siblings&"; 
 %>

<%-- Iterate through all the category's ancestors, creating a browse link for each --%>

<es:forEachInArray id="ancestor" 
 type="com.beasys.commerce.ebusiness.catalog.Category" array="<%= 
 ancestors %>" counterId="i">

<%-- Add a link to the main catalog page in the case of the last ancestor --%>

<% if (i.intValue() == 0) { %>
   <p><a href="<webflow:createWebflowURL event="link.home" 
   namespace="sampleapp_main"/>">Home</a>

<%-- Otherwise, link to the browse page for the current ancestor --%>

<% } else { 
   String xtraParams = commonParameters +
   HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
   java.net.URLEncoder.encode(ancestor.getKey().getIdentifier());
   %>

   <a href="<webflow:createWebflowURL event="link.browse" 
    namespace="sampleapp_main" extraParams="<%= xtraParams %>" 
    true/>">

   <catalog:getProperty object="<%= ancestor %>" 
    propertyName="Name"/></a>

<% } %>
&nbsp;<b>&gt;</b>

</es:forEachInArray>

<%-- Insert the category name --%>

<b><font color="#333399">
<catalog:getProperty object="<%= category %>" 
 propertyName="Name"/></font></b></p>

</es:notNull>

Notes: For more information on the WebLogic Personalization Server's Utility JSP tags, see Personalization Server JSP Tag Library Reference in the Guide to Building Personalized Applications documentation. For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation. For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld.

About the Included category.jsp Template

The category.jsp template (included in the browse.jsp template) provides a standardized format for the display of hyperlinked subcategories. In the Commerce services (wlcs) Web application, this format is a simple list. However, you can always modify the template to use a different format.

The category.jsp template utilizes Webflow and Catalog JSP tags to generate the specialized content displayed in the browse.jsp template. This is accomplished by first obtaining the current catalog category and its subcategories from the Pipeline Session using the getProperty Webflow JSP tag, as shown in Listing 5-9.

Listing 5-9 Obtaining the CATALOG_CATEGORY and CATALOG_CATEGORIES Properties

<%-- Get the current category from the PipelineSession --%>

<webflow:getProperty id="category" 
 property="<%=PipelineSessionConstants.CATALOG_CATEGORY%>" 
 type="com.beasys.commerce.ebusiness.catalog.Category" 
 scope="request" namespace="sampleapp_main" />

<%-- Get the subcategories from the PipelineSession --%>	

<webflow:getProperty id="subcategories" 
 property="<%=PipelineSessionConstants.CATALOG_CATEGORIES%>" 
 type="com.beasys.commerce.ebusiness.catalog.ViewIterator" 
 scope="request" namespace="sampleapp_main" />

Note: For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Next, a string containing common browse parameters for the page is created. These parameters are used to establish context for the page (that is, a knowledge of previous activity) and provide the Pipelines with appropriate information during their subsequent executions. If there are any individual items at this level in the hierarchy, the category.jsp template retrieves them using the getProperty Webflow JSP tag, and then displays the current category name using the getProperty Catalog JSP tag, as shown in Listing 5-10.

Listing 5-10 Generating Browse Parameters, Obtaining Product Items, and Inserting the Category Name

<%! static final String commonParameters = 
 HttpRequestConstants.CATALOG_SOURCE_KEY + "=" + 
 PipelineSessionConstants.CATALOG_CATEGORIES + "&" + 
 HttpRequestConstants.CATALOG_DESTINATION_KEY + "=wlcs_siblings&"; %>

<webflow:getProperty id="items" 
 property="<%=PipelineSessionConstants.CATALOG_ITEMS%>" 
 type="com.beasys.commerce.ebusiness.catalog.ViewIterator" 
 scope="request" namespace="sampleapp_main" />

<%-- Insert the category name --%>

<table border="0" width="90%" cellpadding="3">
<tr>
   <td align="left">
	<p class="head1"><catalog:getProperty 
	object="<%= category %>" propertyName="Name"/></p>

   </td>

Notes: For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation. For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld.

Following display of the category name, the category.jsp template sets the view. The view is basically a pointer that indicates the location in the complete list of results where we want to start displaying information. This processing is shown in Listing 5-11.

Listing 5-11 Setting the View

<%

// Goto the correct view within the ViewIterator

String viewIndexString = (String)request.getParameter
 (HttpRequestConstants.CATALOG_VIEW_INDEX);

if (viewIndexString == null) { viewIndexString = "0"; }
   int viewIndex = 
   Math.min(Integer.valueOf(viewIndexString).intValue(), 
   items.getViewCount() - 1);

if (viewIndex > 0) { items.gotoViewAt(viewIndex); }
   String myParams = null;

%>

The category.jsp template now counts the number of itemsummary.jsp files used (the number of items), and inserts a numeric range of items across from the category name. For example, if there are nine items on the page, the category.jsp template inserts 1 - 9 to indicate that the page contains items one through nine. If there are enough items to create more than one page (for example, more than 10 items), the template inserts Previous and/or Next hyperlinks to navigate to the previous or next page of items, depending on where the visitor is. This is shown in Listing 5-12.

Listing 5-12 Setting the Number of Items, Previous and Next Links

<%-- Add "Next" and "Previous" top navigation --%>

<% if (items.size() > 0) { %>

   <td align="right">

   <%-- Add "Previous" link --%>

   <% if (items.hasPreviousView()) { 
	myParams = commonParameters + 	
	HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
	java.net.URLEncoder.encode(category.getKey().
	getIdentifier()) + "&" + 
	HttpRequestConstants.CATALOG_VIEW_INDEX + "=" + (viewIndex - 
	1);

   %>

   <b><a href="<webflow:createWebflowURL event="link.browse" 
   namespace="sampleapp_main" extraParams="<%= myParams %>" 
   />">Previous</a> | </b>

   <% } %>

   <%-- Add current view indicies --%>

   <% if (items.size() > 1) { %>
	<b><%= items.getCurrentView().getFirstIndex() %> - <%= 
	items.getCurrentView().getLastIndex() %></b>
   <% } %>

   <%-- Add "Next" link --%>

   <% if (items.hasNextView()) { 
	myParams = commonParameters + 
	HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
	java.net.URLEncoder.encode(category.getKey().
	getIdentifier()) + "&" + 
	HttpRequestConstants.CATALOG_VIEW_INDEX + "=" + (viewIndex + 
	1);
   %>

   <b> | <a href="<webflow:createWebflowURL event="link.browse" 
   namespace="sampleapp_main"  extraParams="<%= myParams %>" 
   />">Next</a></b>

   </td>

   <% } %>
<% } %>

Note: For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Any subcategories associated with the category are then displayed as hyperlinks that allow the customer to browse further. This is done using the iterateViewIterator Catalog JSP tag, as shown in Listing 5-13.

Listing 5-13 Displaying Hyperlinked Subcategories

<%-- Subcategory list --%>

<%-- Iterate through all subcategories, creating a browse link for each. --%>

<center>
<table cellpadding="3" border="0" width="90%">

   <catalog:iterateViewIterator iterator="<%= subcategories %>" 
   id="subcategory"   
   returnType="com.beasys.commerce.ebusiness.catalog.Category">

   <tr><td width="30%" valign="top">
	<p class="tabletext">

       <% myParams = commonParameters + 
	 HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
        	java.net.URLEncoder.encode(subcategory.getKey().
	 getIdentifier());
       %>

	<a href="<webflow:createWebflowURL event="link.browse" 
	 namespace="sampleapp_main" extraParams="<%= myParams %>" 
	 />">

	<catalog:getProperty object="<%= subcategory %>" 
	 propertyName="Name"/></a>

	</p>

   </td></tr>

   </catalog:iterateViewIterator>

</table>
</center>

<hr size="1" width="90%" align="left">	

Notes: For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld. For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

If individual product items were obtained, the category.jsp template iterates through each item using the iterateThroughView and getProperty Catalog JSP tags, and includes an itemsummary.jsp template to display the information related to each item, as shown in Listing 5-14.

Listing 5-14 Iterating Through and Displaying Product Item Information

<%-- Iterate through all items in the current view and display summary information about each --%>

<catalog:iterateThroughView iterator="<%= items %>" id="item" 
 returnType="com.beasys.commerce.ebusiness.catalog.ProductItem" 
 viewIndex="<%= viewIndex %>">	

   <%-- Add the required parameters for the included JSP to the 
   request --%>

   <% request.setAttribute("product_item", item); %>
   <% request.setAttribute("details_link", "details"); %>

   <%-- Get the summary JSP from the current product item --%>

   <catalog:getProperty object="<%= item %>" propertyName="Jsp" 
    getterArgument="<%= new 
    Integer(ProductItem.SUMMARY_DISPLAY_JSP_INDEX) %>" 
    id="summaryJsp"
    returnType="com.beasys.commerce.ebusiness.catalog.JspInfo"/>

   <%-- Include the summary JSP --%>

   <jsp:include page="<%= summaryJsp.getUrl() %>" flush="true"/>

</catalog:iterateThroughView>

Notes: For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld. For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

About the Included itemsummary.jsp Template

The itemsummary.jsp template (included in the category.jsp template) provides a standardized format for the display of specific product items. In the Commerce services (wlcs) Web application, this format contains an image, a link to more details about the item (that is, to the details.jsp template), some brief information about the item, and an Add to Cart button. However, you can always modify the template to use a different format.

The itemsummary.jsp template uses a combination of Webflow, Catalog, and the WebLogic Personalization Server's Utility JSP tags to generate the specialized content displayed for each item within the category.jsp template. This is accomplished by first obtaining all required parameters from the request object, and then obtaining the current catalog category (that is, the CATALOG_CATEGORY property) from the Pipeline Session using the getProperty Webflow JSP tag, as shown in Listing 5-15.

Listing 5-15 Obtaining Request Object Parameters and the CATALOG_CATEGORY Property

<%-- Get all required parameters from the request object --%>

<% ProductItem productItem = 
(ProductItem)request.getAttribute("product_item"); %>

<% String detailsLink = 
(String)request.getAttribute("details_link"); %>

<%-- Get the current category from the PipelineSession --%>

<webflow:getProperty id="category" 
 property="<%=PipelineSessionConstants.CATALOG_CATEGORY%>" 
 type="com.beasys.commerce.ebusiness.catalog.Category" 
 scope="request" namespace="sampleapp_main" />

Note: For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Next, each piece of descriptive information for the item is displayed, using the getProperty Catalog JSP tag and the <es> WebLogic Personalization Server Utility JSP tag, as shown in Listing 5-16. The display of the item is also tracked.

Listing 5-16 Displaying and Tracking Product Item Information

<%-- Fire Behavior Tracking display event --%>

<%-- Add the small image --%>

<catalog:getProperty object="<%= productItem %>"
 propertyName="Image"
 getterArgument="<%= new Integer(ProductItem.SMALL_IMAGE_INDEX) 
 %>"
 id="smallImage"
 returnType="com.beasys.commerce.ebusiness.catalog.ImageInfo"/>

<td valign="top">
   <img src="<webflow:createResourceURL 
    resource="<%=smallImage.getUrl()%>"/>" align="left">
</td>

<td align="left" valign="top" width="90%">

<%-- Add the item name and creator --%>
<%-- Create the details link --%>
<% String detailsUrl = null; %>

<es:isNull item="<%= category %>">
   <%
	detailsUrl = WebflowJSPHelper.createWebflowURL(pageContext,  
	"sampleapp_main", "itemsummary.jsp", "link." + detailsLink, 
	null, HttpRequestConstants.CATALOG_ITEM_SKU + "=" + 
	productItem.getKey().getIdentifier() + "&" + 
	HttpRequestConstants.DOCUMENT_TYPE + "=" + detailsLink,
	true, false);
   %>
</es:isNull>

<es:notNull item="<%= category %>">
   <%
	detailsUrl = WebflowJSPHelper.createWebflowURL(pageContext, 
	"sampleapp_main", "itemsummary.jsp", "link." + detailsLink, 
	null, HttpRequestConstants.CATALOG_ITEM_SKU + "=" + 
	productItem.getKey().getIdentifier() + "&" +
	HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
	category.getKey().getIdentifier() + "&" +
	HttpRequestConstants.DOCUMENT_TYPE + "=" + detailsLink, 
	true, false);
   %>
</es:notNull>

<div class="tabletext">
<b>

<%-- we will fire off a clickProductEvent when the user clicks on the product details to see this product --%>

   <productTracking:clickProductEvent id="url" documentId="<%= 
    productItem.getName() %>" 
    sku="<%= productItem.getKey().getIdentifier() %>" />

   <% detailsUrl = detailsUrl + "&" + url; %>

   <a href="<%= detailsUrl %>">
	<catalog:getProperty object="<%= productItem %>" 
	propertyName="Name"/>
   </a>

</b>,

<catalog:getProperty object="<%= productItem %>" 
 propertyName="Creator"/>

</div>

<%-- Add the item price --%>

<div class="tabletext">
<b>

<catalog:getProperty object="<%= productItem %>"
 propertyName="CurrentPrice" id="price"	
 returnType="com.beasys.commerce.axiom.units.Money"/>

<i18n:getMessage bundleName="/commerce/currency" messageName="<%= 
 price.getCurrency() %>"/><%= 
 WebflowJSPHelper.priceFormat(price.getValue()) %>

</b>, Reg.

<catalog:getProperty object="<%= productItem %>"	
 propertyName="Msrp" id="msrp"
 returnType="com.beasys.commerce.axiom.units.Money"/>

<i18n:getMessage bundleName="/commerce/currency" messageName="<%= 
 msrp.getCurrency() %>"/><%= 
 WebflowJSPHelper.priceFormat(msrp.getValue()) %>

</b>
</div>

<%-- Add inventory information --%>

<catalog:getProperty object="<%= productItem %>"
 propertyName="Availability" id="inventory"
 returnType="com.beasys.commerce.ebusiness.catalog.
 InventoryInfo"/>

<div class="tabletext">
<b>

<% if (inventory.getInStock()) { %>
   In stock (<%= inventory.getShippingTime() %>)
<% } else { %>
   Out of stock.
<% } %>

</b>
</div>

<%-- Add a short description of the item --%>

<br><div class="tabletext">

<catalog:getProperty object="<%= productItem %>"
 propertyName="Description"	getterArgument="<%= new 
 Integer(CatalogItem.SHORT_DESCRIPTION_INDEX) %>" />

</div>

<%-- Add the 'Add to Cart' link --%>

<div align="right">
<%
String tmpParams = HttpRequestConstants.CATALOG_ITEM_SKU + "=" + 
productItem.getKey().getIdentifier();
%>

<a href="<webflow:createWebflowURL event="link.add" 
 namespace="sampleapp_order" extraParams="<%=tmpParams%>"/>"><img 
 src="<webflow:createResourceURL 
 resource="/commerce/images/btn_addcart.gif"/>" alt="Add To 
 Shopping Cart" border="0" vspace="4"></a>

</div>
</td>

Notes: For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld. For more information on the WebLogic Personalization Server's Utility JSP tags, see Personalization Server JSP Tag Library Reference in the Guide to Building Personalized Applications documentation. For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Events

Every time a customer clicks a link or a button on the browse.jsp template, it is considered an event. Each event triggers a particular response in the default Webflow that allows the customer to continue. While this response can be to load another JSP, it is usually the case that an Input Processor and/or Pipeline is invoked first. Table 5-3 provides information about these events and the Webflow response(s) they invoke.

Note: Descriptions are provided for Pipelines only.

Table 5-3 browse.jsp (and included category.jsp) Events

Event	Webflow Response(s)	Description
link.browse	browseCategory (IP) moveSiblingResults (IP)	--
	getBrowseDetails	Contains GetCategoryPC, GetParentPC, GetSubcategoriesPC, MoveAttributePC, GetCategoryPC2, GetAncestorsPC, GetSubcategoriesPC2, GetProductItemsPC and is not transactional.

 

Because the category.jsp template also includes the itemsummary.jsp template, the events shown in Table 5-4 are also considered part of the browse.jsp template.

Table 5-4 itemsummary.jsp Events

Event	Webflow Response(s)	Description
link.details	getProductItemDetails (IP)	--
link.add	addProductItemToShoppingCart (IP)	--

 

Notes: The link.details event for this JSP is dynamically generated.

For more information about individual Input Processors, see Input Processors. For more information about individual Pipeline Components, see Pipeline Components.

Dynamic Data Display

The primary purpose of the browse.jsp template is to dynamically display content based on the hyperlinked path a customer chooses to follow. As previously described, this is accomplished mostly through the included category.jsp and itemsummary.jsp templates. (For more information, see About the Included category.jsp Template and About the Included itemsummary.jsp Template.)

However, there is still some dynamic data that is handled solely by the browse.jsp template; that is, the list of sibling categories above the category name. To accomplish this, the browse.jsp template first calls the included navigation.jsp template to determine whether or not to display an ancestor category navigation bar, as shown in Listing 5-17.

Listing 5-17 Determining Whether to Display an Ancestor Category Navigation Bar

<!-- ancestor category navigation bar -->

<jsp:include page="/commerce/catalog/includes/navigation.jsp" flush="true"/>

Note: For detailed information about the navigation.jsp template, see About the Included navigation.jsp Template.

After the include of navigation.jsp, the browse.jsp template uses the getProperty Webflow JSP tag to retrieve the CATALOG_ANCESTORS and wlcs_siblings properties from the Pipeline Session. Table 5-5 provides more detailed information on these properties.

Table 5-5 browse.jsp Pipeline Session Properties

Property	Type	Description
PipelineSessionConstants.CATALOG_ANCESTORS	com.beasys.commerce.ebusiness.catalog.Category	Contains the ancestors a given category.
wlcs_siblings	com.beasys.commerce.ebusiness.catalog.ViewIterator	Contains the siblings for a given category.

 

Listing 5-18 illustrates how these properties are retrieved from the Pipeline Session using the getProperty Webflow JSP tag.

Listing 5-18 Obtaining the CATALOG_ANCESTORS and wlcs_siblings Properties

<!-- get the sibling categories -->

<hr size="1" width="90%" align="left">	

<%-- Get the category's ancestors from the PipelineSession --%>

<webflow:getProperty id="ancestors" 
 property="<%=PipelineSessionConstants.CATALOG_ANCESTORS%>" 
 type="com.beasys.commerce.ebusiness.catalog.Category[]" 
 scope="request" namespace="sampleapp_main" />.
.
.
.

<%-- Get the siblings from the PipelineSession --%>

<webflow:getProperty id="siblings" property="wlcs_siblings" 
 type="com.beasys.commerce.ebusiness.catalog.ViewIterator" 
 scope="request" namespace="sampleapp_main" />

Note: For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Next, a string containing common browse parameters for the page is created. These parameters are used to establish context for the page (that is, a knowledge of previous activity) and provide the Pipelines with appropriate information during their subsequent executions. The iterateViewIterator and getProperty Catalog JSP tags are then used to iterate through the siblings and create browse hyperlinks for each of them (if appropriate), as shown in Listing 5-19. This activity happens prior to any calls to the included category.jsp and/or itemsummary.jsp templates.

Listing 5-19 Establishing Common Browse Parameters and Creating Browse Links for Categories

<%-- Declare a String containing common browse parameters --%>

<%! static final String commonParameters = 
 HttpRequestConstants.CATALOG_SOURCE_KEY + "=" + 
 PipelineSessionConstants.CATALOG_CATEGORIES + "&" +
 HttpRequestConstants.CATALOG_DESTINATION_KEY + "=wlcs_siblings&"; 
 %>

<%-- Iterate through all siblings, creating a browse link for each. --%>

<catalog:iterateViewIterator iterator="<%= siblings %>" 
 id="sibling" 
 returnType="com.beasys.commerce.ebusiness.catalog.Category">

<%-- Just highlight the category name if the current sibling is the current category --%>

<% if (sibling.getKey().equals(category.getKey())) { %>
   <b><font color="#333399"><catalog:getProperty object="<%= 
   sibling %>" propertyName="Name"/></font></b>

<% } else { %>

<%-- Otherwise, link to the browse page for the current sibling --%>

   <%
   String extraParams = commonParameters + 
   HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
   java.net.URLEncoder.encode(sibling.getKey().getIdentifier());

   %>

   <a href="<webflow:createWebflowURL event="link.browse" 
    extraParams="<%= extraParams %>" namespace="sampleapp_main" 
    />"><catalog:getProperty object="<%= sibling %>" 
    propertyName="Name"/>
   </a>&nbsp;

<% } %>

</catalog:iterateViewIterator>

Note: For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld. For more information on the Webflow JSP tags, see Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Form Field Specification

No form fields are used in the browse.jsp template, nor in the browse.jsp template's included category.jsp or itemsummary.jsp templates.

details.jsp Template

The brief description presented for each product item on the generated itemsummary.jsp templates includes a hyperlink to the item. (For more information about the itemsummary.jsp template, see About the Included itemsummary.jsp Template.) When customers click this link, the browser loads the details.jsp template, which customer can use to view more detailed information about the item.

Although the Commerce services (wlcs) Web application presents the same information on the itemsummary.jsp template and the details.jsp template, you can use this page separation to customize or localize the content for your customers. For more information about localization and internationalization using these JSPs, see Method 2: Parsing Language-Specific Data.

Because the name of the detailed display JSP is loaded from the database (that is, it does not have to always be details.jsp), you can have different display JSPs for different Product Catalog items. For example, you can provide custom display JSPs to include seasonal text. The Product Catalog administrator simply needs to switch between the detailed display JSPs (once they have been tested) using the Administration Tools. For more information about the Product Catalog Administration Tools, see Catalog Administration Tasks.

Sample Browser View

Figure 5-8 shows a version of a details.jsp template.

Figure 5-8 The details.jsp Template

 
 

The numbers in the following list refer to the numbered regions in the figure:

1. The admin banner is created from an import of the admin.inc template. The banner provides links to the current template's About information, the JSP template index, and the Administration Tools page. The import call is:

   <%@ include file="/commerce/includes/admin.inc" %>

   You should remove the admin.inc template from the production pages before you move them to your live server.

2. The page header is created from an import of the header.inc template. This is standard across most of the JSP templates provided by Commerce services. The import call is:

   <%@ include file="/commerce/includes/header.inc" %>

   The header.inc file creates the top banner and reserves space for the left-side column. The contents of the left-side column are determined by other processing (see main.jsp Template for more information).

3. Region 3 of the details.jsp template is created by the included navigation2.jsp, which conditionally displays an ancestor category navigation bar in the form of breadcrumbs. The call to include this JSP is:

   <jsp:include page="/commerce/catalog/includes/navigation2.jsp"  
    flush="true"/>

4. Region 4 of the details.jsp template shows the results generated from processing with the Webflow mechanism, which located the detailed information for this particular product item (presented in the included itemdetails.jsp template).

5. Region 5 of the details.jsp template contains the included footer.inc template. The include statement is:

   <%@ include file="/commerce/includes/footer.inc" %>

   The footer.inc file consists of the horizontal footer at the bottom of the page.

Location in the Directory Structure

You can find the details.jsp file at the following location, where PORTAL_HOME is the directory in which you installed WebLogic Portal:

%PORTAL_HOME%\applications\wlcsApp\wlcs\commerce\catalog\
details.jsp (Windows)
$PORTAL_HOME/applications/wlcsApp/wlcs/commerce/catalog/
details.jsp (UNIX)

Tag Library Imports

The details.jsp template uses Webflow, Catalog, and Product Tracking JSP tags. Therefore, the template includes the following JSP tag libraries:

<%@ taglib uri="webflow.tld" prefix="webflow" %>
<%@ taglib uri="cat.tld" prefix="catalog" %>
<%@ taglib uri="productTracking.tld" prefix="productTracking" %>

Notes: For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation. For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld For more information about the Product Tracking JSP Tags, see JSP Tag Library Reference for Events and Behavior Tracking in the Guide to Events and Behavior Tracking documentation.

These files reside in the following directory for the Commerce services (wlcs) Web application:

%PORTAL_HOME%\applications\wlcsApp\wlcs\WEB-INF (Windows)
$PORTAL_HOME/applications/wlcsApp/wlcs/WEB-INF (UNIX)

Java Package Imports

The details.jsp template uses Java classes in the following packages and therefore includes these import statements:

<%@ page import="com.beasys.commerce.ebusiness.catalog.*" %>
<%@ page import="com.beasys.commerce.webflow.PipelineSessionConstants" %>
<%@ page import="com.bea.commerce.ebusiness.tracking.events.DisplayProductEvent" %>

Location in the Default Webflow

The details.jsp template is displayed when a customer clicks on a link for a particular product item shown on an itemsummary.jsp template (part of the browse.jsp or search.jsp templates). The details.jsp is part of the sampleapp_main namespace. From the details.jsp template, the customer can choose to browse back up the ancestor category navigation bar (which loads the browse.jsp template) or add the product item to their shopping cart (which loads the shoppingcart.jsp template).

Note: For more information about the default Webflow, see Figure 5-1.

Included JSP Templates

The following JSP templates are included into the details.jsp template:

• admin.inc, which creates the admin banner that provides links to the current template's About information, the JSP template index, and the Administration Tools page.

• stylesheet.inc, which is a cascading stylesheet that defines global paragraph and text styles for the site.

• header.inc, which creates the top banner and reserves space for the left-side column. The contents of the left-side column are determined by processing in the included leftside.inc.

• leftside.inc, which provides a keyword-based search tool for finding product items via keywords that have already been assigned, and additional links if customers are logged in.

• navigation2.jsp, which builds an ancestor category navigation bar from the top-level Home category down to the current category (under specific conditions). The navigation2.jsp template is similar to the navigation.jsp template, except that it also adds a link for the top-level category. For more information about the navigation2.jsp template, see About the Included navigation2.jsp Template.

• itemdetails.jsp, which displays the detailed information about the selected product item. For more details about the itemdetails.jsp template, see About the Included itemdetails.jsp Template.

• footer.inc, which creates a horizontal footer at the bottom of the page.

About the Included navigation2.jsp Template

The navigation2.jsp template (included in the details.jsp template) is responsible for generating the ancestor category navigation bar that is shown at the top of the page. The navigation2.jsp template utilizes Webflow, Catalog, and the WebLogic Personalization Server's Utility JSP tags to generate this content.

First, the getProperty Webflow JSP tag is used to obtain the current category (that is, the CATALOG_CATEGORY property) from the Pipeline Session, as shown in Listing 5-20.

Listing 5-20 Obtaining the CATALOG_CATEGORY Property

<webflow:getProperty id="category" 
 property="<%=PipelineSessionConstants.CATALOG_CATEGORY%>" 
 type="com.beasys.commerce.ebusiness.catalog.Category" 
 scope="request" namespace="sampleapp_main" />

Note: For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Next, the <es> JSP tag (one of the WebLogic Personalization Server Utility JSP tags) is used to ensure that the conditions under which the ancestor category navigation bar is displayed are appropriate. If so, the category's ancestors are obtained from the Pipeline Session (again using the getProperty Webflow JSP tag).

Listing 5-21 Establishing Conditional Display of the Navigation Bar and Obtaining the Category's Ancestors

<%-- Only output the navigation bar if a current category exists in the PipelineSession --%>

<es:notNull item="<%= category %>">

<%-- Get the category's ancestors from the PipelineSession --%>

<webflow:getProperty id="ancestors" 
 property="<%=PipelineSessionConstants.CATALOG_ANCESTORS%>" 
 type="com.beasys.commerce.ebusiness.catalog.Category[]" 
 scope="request" namespace="sampleapp_main" />

Notes: For more information on the WebLogic Personalization Server's Utility JSP tags, see Personalization Server JSP Tag Library Reference in the Guide to Building Personalized Applications documentation. For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Browse parameters for the navigation2.jsp template are concatenated into a single string, and a link is created for each category ancestor. These parameters are used to establish context for the page (that is, a knowledge of previous activity) and provide the Pipelines with appropriate information during their subsequent executions. In the case of the last ancestor, a link to the main catalog page is also created. This is accomplished with the <es> WebLogic Personalization Server Utility JSP tag and the getProperty Catalog JSP tag, as shown in Listing 5-8.

Listing 5-22 Generating the Ancestor Category Navigation Bar

<%-- Declare a String containing common browse parameters --%>

<%! static final String commonParameters = 
    HttpRequestConstants.CATALOG_SOURCE_KEY + "=" + 
    PipelineSessionConstants.CATALOG_CATEGORIES + "&" + 
    HttpRequestConstants.CATALOG_DESTINATION_KEY + 
    "=wlcs_siblings&"; %>

<%-- Iterate through all the category's ancestors, creating a browse link for each --%>

<es:forEachInArray id="ancestor" 
 type="com.beasys.commerce.ebusiness.catalog.Category" array="<%= 
 ancestors %>" counterId="i">

   <%-- Add a link to the main catalog page in the case of the last 
   ancestor --%>

   <% if (i.intValue() == 0) { %>

     	<p><a href="<webflow:createWebflowURL event="link.home" 
     	namespace="sampleapp_main" />">Home</a>

   <%-- Otherwise, link to the browse page for the current ancestor 
   --%>

   <% } else { 

     	theParams = commonParameters + 	HttpRequestConstants.CATALOG_CATEGORY_ID + 
     "=" + java.net.URLEncoder.encode(ancestor.getKey().getIdentifier());

   %>

   <a href="<webflow:createWebflowURL event="link.browse" 
   namespace="sampleapp_main" extraParams="<%= theParams %>" />">

   <catalog:getProperty object="<%= ancestor %>" propertyName="Name"/></a>

   <% } %>

&nbsp;<b>&gt;</b>

</es:forEachInArray>

<%-- Insert the category link --%>

<%

theParams = commonParameters + HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
java.net.URLEncoder.encode(category.getKey().getIdentifier());

%>

<b>
<a href="<webflow:createWebflowURL event="link.browse" namespace="sampleapp_main" extraParams="<%= theParams %>" />">

<catalog:getProperty object="<%= category %>" propertyName="Name"/></a></b>

</es:notNull>

Notes: For more information on the WebLogic Personalization Server's Utility JSP tags, see Personalization Server JSP Tag Library Reference in the Guide to Building Personalized Applications documentation. For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation. For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld.

About the Included itemdetails.jsp Template

The itemdetails.jsp template (included in the details.jsp template) provides a standardized format for the display of specific item information. In the Commerce services (wlcs) Web application, this format is the same as what is shown in the itemsummary.jsp template, with some exceptions. In the itemdetails.jsp template, for example, there is a link to a larger version of the image, and no link to the product item itself. (For more information about itemsummary.jsp template, see About the Included itemsummary.jsp Template.) Remember, you can always modify the template to use a different format that better suits your requirements.

Events

Every time a customer clicks a link or button on a JSP, it is considered an event. Events trigger particular responses in the default Webflow that allow customers to continue. While this response can be to load another JSP, it is usually the case that an Input Processor and/or Pipeline is invoked first. Because the details.jsp template includes the itemdetails.jsp template (which is used to display most of the information), Table 5-6 provides information about the only event for the included itemdetails.jsp template, and the Webflow response(s) it invokes.

Note: Descriptions are provided for Pipelines only.

Table 5-6 itemdetails.jsp Events

Event	Webflow Response(s)	Description
link.add	addProductItemToShoppingCart (IP)	--
	addProductItemToShoppingCart	Contains GetProductItemPC and AddProductItemToShoppingCartPC, and PriceShoppingCartPC and is not transactional.
	refreshSavedList	Contains RefreshSavedListPC and is not transactional.

 

Notes: For more information about individual Input Processors, see Input Processors. For more information about individual Pipeline Components, see Pipeline Components.

Dynamic Data Display

The primary purpose of the details.jsp template is to dynamically display content about a customer-selected product item. To accomplish this, the details.jsp template first calls the included navigation2.jsp template to determine whether or not to display an ancestor category navigation bar, as shown in Listing 5-23.

Listing 5-23 Determining Whether to Display an Ancestor Category Navigation Bar

<!-- breadcrumbs; ONLY if from MAIN, CUSTOMERMAIN, OR BROWSE; NOT if from SEARCH or SEARCHRESULTS -->

<jsp:include page="/commerce/catalog/includes/navigation2.jsp" flush="true"/>

<hr size="1" width="90%" align="left">

<!-- end conditional breadcrumbs -->

Note: For detailed information about the navigation2.jsp template, see About the Included navigation.jsp Template.

After the include of navigation2.jsp, the details.jsp template obtains the CATALOG_ITEM and CATALOG_CATEGORY properties from the Pipeline Session. Table 5-7 provides more detailed information on these properties.

Table 5-7 details.jsp Pipeline Session Properties

Property	Type	Description
PipelineSessionConstants .CATALOG_ITEM	com.beasys.commerce.ebusiness.catalog.ProductItem	Contains the product item.
PipelineSessionConstants.CATALOG_CATEGORY	com.beasys.commerce.ebusiness.catalog.Category	Contains the root category for the Product Catalog.

 

Listing 5-24 illustrates how these properties are obtained from the Pipeline Session using the getProperty Webflow JSP tag. It also shows how the required request parameters for the included JSP are added to the request. This activity happens prior to any calls to the included itemdetails.jsp template.

Listing 5-24 Obtaining the CATALOG_ITEM and CATALOG_CATEGORY Properties

<%-- Get the item from the PipelineSession --%>

<webflow:getProperty id="item" 
 property="<%=PipelineSessionConstants.CATALOG_ITEM%>" 
 type="com.beasys.commerce.ebusiness.catalog.ProductItem" scope="request" 
 namespace="sampleapp_main" />

<%-- Get the category from the PipelineSession --%>

<webflow:getProperty id="category" 
 property="<%=PipelineSessionConstants.CATALOG_CATEGORY%>" 
 type="com.beasys.commerce.ebusiness.catalog.Category" scope="request" 
 namespace="sampleapp_main" />

<%-- Add the required parameters for the included JSP to the request --%>

<% request.setAttribute("product_item", item); %>
<% request.setAttribute("category", category); %>

Note: For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Next, the details.jsp template uses the Catalog getProperty JSP tag to set up a JspInfo object, which is used to include the URL for the itemdetails.jsp page. Then the details.jsp template displays the product item details (via an include of itemdetails.jsp) and records that display using the productTracking JSP tag, as shown in Listing 5-25.

Listing 5-25 Displaying and Tracking the Product Details

<catalog:getProperty object="<%= item %>" 
 propertyName="Jsp" 
 getterArgument="<%= new 
 Integer(ProductItem.DETAILED_DISPLAY_JSP_INDEX) %>"
 id="detailJsp"
 returnType="com.beasys.commerce.ebusiness.catalog.JspInfo"/>

<%-- Include the detail JSP --%>

<jsp:include page="<%= detailJsp.getUrl() %>" flush="true"/>

<%-- once the product is displayed, fire off a displayProductEvent --%>

<productTracking:displayProductEvent documentId="<%= 
 item.getName() %>" documentType="<%= 
 DisplayProductEvent.ITEM_BROWSE %>"
 sku="<%= item.getKey().getIdentifier() %>" />

Notes: For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld. For more information about the Product Tracking JSP Tags, see "JSP Tag Library Reference for Events and Behavior Tracking" in the Guide to Events and Behavior Tracking documentation.

Form Field Specification

No form fields are used in the details.jsp template, nor in the details.jsp template's included itemdetails.jsp template.

search.jsp

The search.jsp template displays a form field that allows customers to perform advanced searches on the Product Catalog. Searches are performed using Boolean expressions; results are displayed below the search area, using included summary JSPs.

Notes: It is not expected that customers will search a Product Catalog using a free form, text-based query syntax. The free form syntax input field is provided to illustrate the power of the search functionality. You should customize the search.jsp template to include drop-down lists with the attributes that are appropriate for your business or product items. For example, companies selling books might have edit fields that correspond to Author Name, ISBN, Price, and so on. The contents of these fields would then be converted into a search expression and passed to the catalog system for processing.

For more information about using the search.jsp to perform searches and a description of the syntax for a search expression, refer to Query-Based Search Syntax.

Sample Browser View

Figure 5-9 shows a version of the search.jsp template.

Figure 5-9 The search.jsp Template

 

The numbers in the following list refer to the numbered regions in the figure:

1. The admin banner is created from an import of the admin.inc template. The banner provides links to the current template's About information, the JSP template index, and the Administration Tools page. The import call is:

   <%@ include file="/commerce/includes/admin.inc" %>

   You should remove the admin.inc template from the production pages before you move them to your live server.

2. The page header is created from an import of the header.inc template. This is standard across most of the JSP templates provided by Commerce services. The import call is:

   <%@ include file="/commerce/includes/header.inc" %>

   The header.inc file creates the top banner and reserves space for the left-side column. The contents of the left-side column are determined by other processing (see main.jsp Template for more information).

3. Region 3 of the search.jsp template is the search area. It provides examples of searches using Boolean expressions, and provides the form field in which customers can enter their search criteria. Following the execution of a search, this region also includes a search results section, as shown in Figure 5-10.

   Figure 5-10 The search.jsp Template with Search Results

   
    

4. Region 4 of search.jsp contains the included footer.inc template. The include call statement is:

   <%@ include file="/commerce/includes/footer.inc" %>

   The footer.inc file consists of the horizontal footer at the bottom of the page.

Location in the Directory Structure

You can find the search.jsp file at the following location, where PORTAL_HOME is the directory in which you installed WebLogic Portal:

%PORTAL_HOME%\applications\wlcsApp\wlcs\commerce\catalog\
search.jsp (Windows)
$PORTAL_HOME/applications/wlcsApp/wlcs/commerce/catalog/
search.jsp (UNIX)

Tag Library Imports

The search.jsp template uses Webflow, Catalog, and WebLogic Server Utility JSP tags. Therefore, the template includes the following JSP tag libraries:

<%@ taglib uri="webflow.tld" prefix="webflow" %>
<%@ taglib uri="cat.tld" prefix="catalog" %>
<%@ taglib uri="weblogic.tld" prefix="wl" %>

Notes: For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation. For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld For more information on the WebLogic Server Utility JSP tags, see JSP Tag Reference in the Guide to Building Personalized Applications documentation.

These files reside in the following directory for the Commerce services (wlcs) Web application:

%PORTAL_HOME%\applications\wlcsApp\wlcs\WEB-INF (Windows)
$PORTAL_HOME/applications/wlcsApp/wlcs/WEB-INF (UNIX)

Java Package Imports

The search.jsp template uses Java classes in the following packages and therefore includes these import statements:

<%@ page import="com.beasys.commerce.webflow.HttpRequestConstants" %>
<%@ page import="com.beasys.commerce.webflow.PipelineSessionConstants" %>
<%@ page import="com.beasys.commerce.ebusiness.catalog.*" %>

Location in the Default Webflow

The search.jsp template is displayed any time a customer clicks the Search button located in the top banner of most pages, and is part of the sampleapp_search namespace. When a Boolean search is submitted, the search.jsp template is reloaded (with included itemsummary.jsp templates for each resulting item). From any of the included itemsummary.jsp templates, customers can view details about the item (which loads the details.jsp template) or add the item to their shopping cart (which loads the shoppingcart.jsp template). Because search results are viewed in groups of 10 by default, the customer may also be able to click Previous/Next links that reload the search.jsp template with new content.

Note: For more information about the default Webflow, see Figure 5-1.

Included JSP Templates

The following JSP templates are included into the search.jsp template:

• admin.inc, which creates the admin banner that provides links to the current template's About information, the JSP template index, and the Administration Tools page.

• stylesheet.inc, which is a cascading stylesheet that defines global paragraph and text styles for the site.

• header.inc, which creates the top banner and reserves space for the left-side column. The contents of the left-side column are determined by processing in the included leftside.inc.

• leftside.inc, which provides a keyword-based search tool for finding product items via keywords that have already been assigned, and additional links if customers are logged in.

• itemsummary.jsp, which displays the detailed information about each resulting product item. For more details about the itemsummary.jsp template, see About the Included itemsummary.jsp Template.

• footer.inc, which creates a horizontal footer at the bottom of the page.

Events

Every time a customer clicks a link or button on a JSP, it is considered an event. Events trigger particular responses in the default Webflow that allow customers to continue. While this response can be to load another JSP, it is usually the case that an Input Processor and/or Pipeline is invoked first. Table 5-8 provides information about these events and the Webflow response(s) they invoke.

Note: Descriptions are provided for Pipelines only.

Table 5-8 search.jsp Events

Event	Webflow Response(s)	Description
--	newSearch (IP)	--
	newSearch	Contains RemoveAttributePC and is not transactional.
link.search	expressionSearch (IP)	--
	expressionSearch	Contains SearchPC and is not transactional.

 

Note: The NewSearch Input Processor and Pipeline are not triggered by an event on the search.jsp template. Rather, they are executed when customers click the Search button in the top banner. These mechanisms reset the search results prior to display of the search.jsp template.

Because the search.jsp template also includes the itemsummary.jsp template, the events shown in Table 5-9 are also considered part of the search.jsp template.

Table 5-9 itemsummary.jsp Events

Event	Webflow Response(s)	Description
link.itemdetails	getProductItemDetails (IP)	--
link.add	addProductItemToShoppingCart (IP)	--

 

Notes: The link.itemdetails event for this JSP is dynamically generated.

For more information about individual Input Processors, see Input Processors. For more information about individual Pipeline Components, see Pipeline Components.

Dynamic Data Display

One purpose of the search.jsp template is to present customers with information about the product items that resulted from their search, which customers can then browse. This is accomplished using a combination of Webflow and Catalog JSP tags.

First, the getProperty Webflow JSP tag is used to obtain the CATALOG_SEARCH_RESULTS property from the Pipeline Session. Table 5-10 provides more detailed information on this property.

Table 5-10 search.jsp Pipeline Session Properties

Property	Type	Description
PipelineSessionConstants.CATALOG_SEARCH_RESULTS	com.beasys.commerce.ebusiness.catalog.ViewIterator	Contains the results of the customer's search.

 

Listing 5-26 illustrates how this property is obtained from the Pipeline Session using the getProperty Webflow JSP tag.

Listing 5-26 Obtaining the CATALOG_SEARCH_RESULTS Property

<webflow:getProperty id="results"
 property="<%=PipelineSessionConstants.CATALOG_SEARCH_RESULTS%>"
 type="com.beasys.commerce.ebusiness.catalog.ViewIterator" scope="request"
 namespace="sampleapp_main" />

Note: For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Then, the search.jsp template sets the view. The view is a pointer that indicates the location in the complete list of results where we want to start displaying information. This processing is shown in Listing 5-27.

Listing 5-27 Setting the View of the Search Results

<% if (results != null && results.size() > 0) { %>
   <%-- Goto the correct view within the ViewIterator --%>
   <% String viewIndexString =
   (String)request.getParameter(HttpRequestConstants.CATALOG_VIEW_INDEX); %>

   <% if (viewIndexString == null) { viewIndexString = "0"; } %>
      <% int viewIndex = Math.min(Integer.valueOf(viewIndexString).intValue(),
      results.getViewCount() - 1); %>
      <% results.gotoViewAt(viewIndex); %>

Next, if the search results require more than one view, a navigation bar (containing Previous and Next links, as well as text showing the results currently being viewed) is generated, as shown in Listing 5-28.

Listing 5-28 Generating the View Navigation Bar

<!-- Add search results navigation bar -->

<table border="0" width="90%">
<tr>

<td align="left" valign="top"><p class="head2">Results of your search</p></td>
<td align="right" valign="bottom"><p class="tabletext">			
<b>

<%-- Add previous link --%>

<% if (results.hasPreviousView()) { 
   String myParams = HttpRequestConstants.CATALOG_VIEW_INDEX + "=" + (viewIndex 
   - 1); %>

<a href="<webflow:createWebflowURL namespace="sampleapp_search" 
 event="link.search" extraParams="<%=myParams%>" />">Previous</a> |

<% } %>

<%-- Add current view indicies --%>

<% if (results.size() > 1) { %>
   <%= results.getCurrentView().getFirstIndex() %> - <%= 
   results.getCurrentView().getLastIndex() %>

<% } %>

<%-- Add next link --%>

<% if (results.hasNextView()) { 
   String myParams2 = HttpRequestConstants.CATALOG_VIEW_INDEX + "=" + (viewIndex 
   + 1);

%> | 

<a href="<webflow:createWebflowURL namespace="sampleapp_search" 
   event="link.search" extraParams="<%=myParams2%>" />">Next</a>

<% } %>

</b>
</td>
</tr>

</table>

Lastly, the iterateThroughView Catalog JSP tag is used to iterate through the product items that are in the current view. The required parameters for the included JSP are added to the request, and the getProperty Catalog JSP tag obtains the correct itemsummary.jsp templates for inclusion into the search.jsp template. This processing is shown in Listing 5-29.

Listing 5-29 Obtaining and Displaying the Product Item Summaries

<%-- Iterate through the items in the current view, including the summary JSP for each --%>

<catalog:iterateThroughView iterator="<%= results %>" id="item" 
 returnType="com.beasys.commerce.ebusiness.catalog.ProductItem" viewIndex="<%= 
 viewIndex %>">

<%-- Add the required parameters for the included JSP to the request --%>

<% request.setAttribute("product_item", item); %>
<% request.setAttribute("details_link", "itemdetails"); %>

<%-- Get the summary JSP from the current product item --%>

<catalog:getProperty object="<%= item %>" propertyName="Jsp" getterArgument="<%= 
 new Integer(ProductItem.SUMMARY_DISPLAY_JSP_INDEX) %>" id="summaryJsp"
 returnType="com.beasys.commerce.ebusiness.catalog.JspInfo"/>

<%-- Included the summary JSP --%>

<jsp:include page="<%= summaryJsp.getUrl() %>" flush="true"/>

</catalog:iterateThroughView>

Note: For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld

Form Field Specification

The primary purpose of the search.jsp template is to allow customers to enter their search criteria into an HTML form field. It is also used to pass needed information to the Webflow.

The form fields used in the search.jsp template, and a description for each of these form fields are listed in Table 5-11.

Table 5-11 search.jsp Form Fields

Parameter Name	Type	Description
HttpRequestConstants. CATALOG_VIEW_SIZE	Hidden	Optional parameter that lets you specify the number of items shown in a result view.
HttpRequestConstants. CATALOG_SEARCH_STRING	Text	The form field into which customers will enter their search criteria.
HttpRequestConstants. CATALOG_SOURCE_KEY	Hidden	Used to determine whether results are from a new search or an iteration through an existing search.

 

Note: Parameters that are literals in the JSP code are shown in quotes, while non-literals will require scriptlet syntax (such as
<%= HttpRequestConstants.CATALOG_VIEW_SIZE %>) for use in the JSP.

searchresults.jsp

The searchresults.jsp template displays results from a keyword search that is launched from the Quick Look-up text field. The Quick Look-up is available in the left-side column of any page on the site.

Sample Browser View

Figure 5-11 shows a version of the searchresults.jsp template.

Figure 5-11 The searchresults.jsp Template

 

The numbers in the following list refer to the numbered regions in the figure:

1. The admin banner is created from an import of the admin.inc template. The banner provides links to the current template's About information, the JSP template index, and the Administration Tools page. The import call is:

   <%@ include file="/commerce/includes/admin.inc" %>

   You should remove the admin.inc template from the production pages before you move them to your live server.

2. The page header is created from an import of the header.inc template. This is standard across most of the JSP templates provided by Commerce services. The import call is:

   <%@ include file="/commerce/includes/header.inc" %>

   The header.inc file creates the top banner and reserves space for the left-side column. The contents of the left-side column are determined by other processing (see step 3 below and main.jsp Template for more information).

3. Region 3 of the searchresults.jsp template contains the leftside.inc template that is included. This template provides a keyword-search feature. The include statement is:

   <%@ include file="/commerce/includes/leftside.inc" %>

4. Region 4 provides customers with a link back to the home page (that is, the main.jsp template) and some information about how many matches to their search criteria were identified. Both are presented in a format that is similar to the ancestor category navigation bar that appears on the browse.jsp template.

   Note: For more information about the browse.jsp template, see browse.jsp Template.

5. Region 5 of the searchresults.jsp template shows the results generated from processing with the Webflow mechanism, which located the detailed information for each resulting product item (presented in the included itemsummary.jsp template).

6. Region 6 of the searchresults.jsp template contains the included footer.inc template. The include statement is:

   <%@ include file="/commerce/includes/footer.inc" %>

   The footer.inc file consists of the horizontal footer at the bottom of the page.

   
    

Location in the Directory Structure

You can find the searchresults.jsp file at the following location, where PORTAL_HOME is the directory in which you installed WebLogic Portal:

%PORTAL_HOME%\applications\wlcsApp\wlcs\commerce\catalog\
searchresults.jsp (Windows)
$PORTAL_HOME/applications/wlcsApp/wlcs/commerce/catalog/
searchresults.jsp (UNIX)

Tag Library Imports

The searchresults.jsp template uses Webflow, Catalog, and the WebLogic Personalization Server Utility JSP tags. Therefore, the template includes the following JSP tag libraries:

<%@ taglib uri="webflow.tld" prefix="webflow" %>
<%@ taglib uri="cat.tld" prefix="catalog" %>
<%@ taglib uri="es.tld" prefix="es" %>

Notes: For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation. For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld. For more information on the WebLogic Server Utility JSP tags, see JSP Tag Reference in the Guide to Building Personalized Applications documentation.

These files reside in the following directory for the Commerce services (wlcs) Web application:

%PORTAL_HOME%\applications\wlcsApp\wlcs\WEB-INF (Windows)
$PORTAL_HOME/applications/wlcsApp/wlcs/WEB-INF (UNIX)

Java Package Imports

The searchresults.jsp template uses Java classes in the following packages and therefore includes these import statements:

<%@ page import="com.beasys.commerce.ebusiness.catalog.*" %>
<%@ page import="com.beasys.commerce.webflow.HttpRequestConstants" %>
<%@ page import="com.beasys.commerce.webflow.PipelineSessionConstants" %>

Location in the Default Webflow

The searchresults.jsp is located in the sampleapp_search namespace. Customers arrive at the searchresults.jsp template after they enter a keyword in the Quick Look-up text field (located in the left-side column of every page) and click the Find button. From here, customers can navigate back to the main.jsp template using the Home link at the top of the page. Customers can also choose to view more details about a particular item shown in the results list (which loads the details.jsp template), or add the product item to their shopping cart (which loads the shoppingcart.jsp template). Finally, customers can also choose to perform another search by using the Quick Look-up again.

Note: For more information about the default Webflow, see Figure 5-1.

Included JSP Templates

The following JSP templates are included into the searchresults.jsp template:

• admin.inc, which creates the admin banner that provides links to the current template's About information, the JSP template index, and the Administration Tools page.

• stylesheet.inc, which is a cascading stylesheet that defines global paragraph and text styles for the site.

• header.inc, which creates the top banner and reserves space for the left-side column. The contents of the left-side column are determined by processing in the included leftside.inc.

• leftside.inc, which provides a keyword-based search tool for finding product items via keywords that have already been assigned, and additional links if customers are logged in.

• itemsummary.jsp, which displays the detailed information about each resulting product item. For more details about the itemsummary.jsp template, see About the Included itemsummary.jsp Template.

• footer.inc, which creates a horizontal footer at the bottom of the page.

Events

Every time a customer clicks a link or button on a JSP, it is considered an event. Events trigger particular responses in the default Webflow that allow customers to continue. While this response can be to load another JSP, it is usually the case that an Input Processor and/or Pipeline is invoked first. Table 5-12 provides information about these events and the Webflow response(s) they invoke.

Note: Descriptions are provided for Pipelines only.

Table 5-12 searchresults.jsp Events

Event	Webflow Response(s)	Description
link.home	No business logic required. Loads index.jsp.	--
link.quicksearch	keywordSearch (IP)	--
	keywordSearch	Contains SearchPC and is not transactional.

 

Because the searchresults.jsp template also includes the itemsummary.jsp template, the events shown in Table 5-13 are also considered part of the searchresults.jsp template.

Table 5-13 itemsummary.jsp Events

Event	Webflow Response(s)	Description
link.itemdetails	getProductItemDetails (IP)	--
link.add	addProductItemToShoppingCart (IP)	--

 

Notes: The link.itemdetails event for this JSP is dynamically generated.

For more information about individual Input Processors, see Input Processors. For more information about individual Pipeline Components, see Pipeline Components.

Dynamic Data Display

The primary purpose of the searchresults.jsp template is to present customers with information about the product items that resulted from their search, which customers can then browse through. This is accomplished using a combination of Webflow and Catalog JSP tags.

First, the getProperty Webflow JSP tag is used to obtain the CATALOG_QUERY and CATALOG_SEARCH_RESULTS properties from the Pipeline Session. Table 5-14 provides more detailed information on these properties.

Table 5-14 searchresults.jsp Pipeline Session Properties

Property	Type	Description
PipelineSessionConstants.CATALOG_QUERY	com.beasys.commerce.ebusiness. catalog.service.query. KeywordQuery	Contains the customer's search criteria.
PipelineSessionConstants.CATALOG_SEARCH_RESULTS	com.beasys.commerce.ebusiness. catalog.ViewIterator	Contains the results of the customer's search.

 

Listing 5-30 illustrates how these properties are obtained from the Pipeline Session using the getProperty Webflow JSP tag.

Listing 5-30 Obtaining the CATALOG_QUERY and CATALOG_SEARCH_RESULTS Properties

<webflow:getProperty id="query" 
 property="<%=PipelineSessionConstants.CATALOG_QUERY%>" 
 type="com.beasys.commerce.ebusiness.catalog.service.query.KeywordQuery" 
 scope="session" namespace="sampleapp_main" />

<webflow:getProperty id="results" 
 property="<%=PipelineSessionConstants.CATALOG_SEARCH_RESULTS%>" 
 type="com.beasys.commerce.ebusiness.catalog.ViewIterator" scope="request" 
 namespace="sampleapp_main" />

Note: For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation.

Next, the navigation bar at the top of the page (containing the Home link and number of matches) is constructed using the <es> WebLogic Personalization Server Utility JSP tag, as shown in Listing 5-31.

Listing 5-31 Constructing the Top Navigation Bar

<% if (results != null && results.size() > 0) { %>

   <p>

   <a href="<webflow:createWebflowURL event="link.home" 
    namespace="sampleapp_main" />">Home</a>

   &nbsp;<b>&gt;</b>
   <b>
   <font color="#9C77DE">

   Result of search for 
   "<es:forEachInArray id="keyword" type="java.lang.String"   
     array="<%= query.getKeywords() %>">
          <%= " " + keyword %>
   </es:forEachInArray>"

   - <%= results.size() %> match<% if (results.size() > 1 || 
   results.size() == 0) { %>es<% } %>

   </font>
   </b>

   </p>

   <hr size="1" width="90%" align="left">

   <% } %>

Notes: For more information on the Webflow JSP tags, see the Webflow JSP Tag Library Reference in the Guide to Managing Presentation and Business Logic: Using Webflow and Pipeline documentation. For more information on the WebLogic Server Utility JSP tags, see JSP Tag Reference in the Guide to Building Personalized Applications documentation.

Then, the searchresults.jsp template sets the view. The view is a pointer that indicates the location in the complete list of results where we want to start displaying information. This processing is shown in Listing 5-32.

Listing 5-32 Setting the View of the Search Results

<!-- Found items are summarized here -->
<% if (results != null && results.size() > 0) { %>
   <%-- Goto the correct view within the ViewIterator --%>
   <% String viewIndexString =
   (String)request.getParameter(HttpRequestConstants.CATALOG_VIEW_INDEX); %>

   <% if (viewIndexString == null) { viewIndexString = "0"; } %>
      <% int viewIndex = Math.min(Integer.valueOf(viewIndexString).intValue(),
      results.getViewCount() - 1); %>
      <% results.gotoViewAt(viewIndex); %>

Next, if the search results require more than one view, a navigation bar (containing Previous and Next links, as well as text showing the results currently being viewed) is generated, as shown in Listing 5-33.

Listing 5-33 Generating the View Navigation Bar

<table border="0" width="90%">
<tr>

<td align="left" valign="top"><p class="head2">Results of your search</p></td>
<td align="right" valign="bottom"><p class="tabletext">

   <b>

   <%-- Add previous link --%>

   <% if (results.hasPreviousView()) { 

     String xtraParams = HttpRequestConstants.CATALOG_VIEW_INDEX + "=" +
     (viewIndex - 1);

   %>

   <a href="<webflow:createWebflowURL event="link.quicksearch" 
   namespace="sampleapp_search" origin="quicksearch.jsp" 
   extraParams="<%=xtraParams%>"/>">Previous</a> |

   <% } %>                          

   <%-- Add current view indicies --%>

   <% if (results.size() > 1) { %>
   <%= results.getCurrentView().getFirstIndex() %> - 
   <%=results.getCurrentView().getLastIndex() %>

   <% } %>

   <%-- Add next link --%>

   <% if (results.hasNextView()) { 

     String xtraParams2 = HttpRequestConstants.CATALOG_VIEW_INDEX + "=" + 
     (viewIndex + 1);

   %>

   | <a href="<webflow:createWebflowURL event="link.quicksearch" 
   namespace="sampleapp_search" origin="quicksearch.jsp" 
   extraParams="<%=xtraParams2%>"/>">Next</a>

   <% } %>

   </b>

</td>

</tr><tr>

<td colspan="2" align="left" valign="top">
   <hr size="1" align="left">
</td>

</tr>
</table>

Lastly, the iterateThroughView Catalog JSP tag is used to iterate through the product items that are in the current view. The required parameters for the included JSP are added to the request, and the getProperty Catalog JSP tag obtains the correct itemsummary.jsp templates for inclusion into the searchresults.jsp template. This processing is shown in Listing 5-34.

Listing 5-34 Obtaining and Displaying the Product Item Summaries

<%-- Iterate through the items in the current view, including the summary JSP for each --%>

<catalog:iterateThroughView iterator="<%= results %>" id="item" 
 returnType="com.beasys.commerce.ebusiness.catalog.ProductItem" viewIndex="<%= 
 viewIndex %>">

   <%-- Add the required parameters for the included JSP to the request --%>

   <% request.setAttribute("product_item", item); %>
   <% request.setAttribute("details_link", "itemdetails"); %>

   <%-- Get the summary JSP from the current product item --%>

   <catalog:getProperty object="<%= item %>" propertyName="Jsp"
    getterArgument="<%= new Integer(ProductItem.SUMMARY_DISPLAY_JSP_INDEX) %>"
    id="summaryJsp" returnType="com.beasys.commerce.ebusiness.catalog.JspInfo"/>

   <%-- Included the summary JSP --%>

   <jsp:include page="<%= summaryJsp.getUrl() %>" flush="true"/>

</catalog:iterateThroughView>

Note: For more information about the Catalog JSP tags, see The Catalog JSP Tag Library: cat.tld.

Form Field Specification

No form fields are used in the searchresults.jsp template.

 

---

Query-Based Search Syntax

Search queries within WebLogic Portal use a syntax similar to the SQL string syntax that supports basic Boolean-type comparison expressions, including nested parenthetical queries. In general, the syntax includes a metadata property name, a comparison operator, and a literal value.

The basic query uses the following syntax:

attribute_name comparison_operator literal_value

Note: Consult the JavadocAPI documentation on com.beasys.commerce.util.ExpressionHelper for more information about the query syntax.

Several constraints apply to queries constructed using this syntax:

• String literals must be enclosed in single quotes, as shown below:

  • `WebLogic Server'

  • `football'

• Date literals can be created via a simplistic toDate method that takes one or two String arguments (enclosed in single quotes). The first, if two arguments are supplied, is the SimpleDateFormat format string; the second argument is the date string. If only one argument is supplied, it should include the date string in the MM/dd/yyyy HH:mm:ss z format (also enclosed in single quotes), as shown below:

  • toDate(`EE dd MMM yyyy HH:mm:ss z', `Thr 06 Apr 2000 16:56:00 MDT')

  • toDate(`02/23/2000 13:57:43 MST')

• Use the toProperty method to compare properties whose names include spaces or other special characters. In general, use toProperty when the property name does not comply with the Java variable-naming convention that uses alphanumeric characters, as shown below:

  • toProperty (`My Property') = `Content'

• To include a scope into the property name, use either scope.propertyName or the toProperty method with two arguments, as shown below:

  • toProperty (`myScope', `myProperty')

    Note: The reference document management system ignores property scopes.

• Use \ along with the appropriate character(s) to create an escape sequence that includes special characters in string literals, as shown below:

  • toProperty (`My Property\'s Contents') = `Content'

• Additionally, use Java-style unicode escape sequences to embed non-ASCII characters in string literals, as shown below:

  • Description like `*\u65e5\u672c\u8a9e*'

Notes: The query syntax can only contain ASCII and extended ASCII characters (0-255).

Use ExpressionHelper.toStringLiteral to convert an arbitrary string to a fully quoted and escaped string literal, which can then be placed in a query.

• The now keyword—only used on the literal value side of the expression—refers to the current date and time.

• Boolean literals are either true or false.

• Numeric literals consist of the numbers themselves without any text decoration (like quotation marks). The system supports scientific notation in the forms (for example, 1.24e4 and 1.24E-4).

• An exclamation mark (!) can be placed at an opening parenthesis to negate an expression, as shown below:

  • !(size >= 256)

• The Boolean and operator is represented by the literal &&, as shown below:

  • author == `james' && age < 55

• The Boolean or operator is represented by the literal ||, as shown below:

  • creationDate > now || expireDate < now

The following examples illustrate full expressions:

Example 1:

((color=`red' && size <=1024) || (keywords contains `red' && creationDate < now))

Example 2:

creationDate > toDate (`MM/dd/yyyy HH:mm:ss', `2/22/2000 14:51:00') && expireDate <= now && mimetype like `text/*'

Using Comparison Operators to Construct Queries

To support advanced searching, the system allows construction of nested Boolean queries incorporating comparison operators. The following table summarizes the comparison operators available for each metadata type.

Operator Type	Characteristics
Boolean (==, !=)	Boolean attributes support an equality check against Boolean.TRUE or Boolean.FALSE.
Numeric (==, !=, >, <, >=, <=)	Numeric attributes support the standard equality, greater than, and less than checks against a java.lang.Number.
Text (==, !=, >, <, >=, <=, like)	Text strings support standard equality checking (case sensitive), plus lexicographical comparison (less than or greater than). In addition, strings can be compared using wildcard pattern matching (that is, the like operator), similar to the SQL LIKE operator or DOS prompt file matching. In this situation, the wildcards will be * (asterisk) for match any and ? (question mark) for match single. Interval matching (for example, using [ ]) is not supported. To match * or ? literally, the escape character will be \ (backslash).
Datetime (==, !=, >, <, >=, <=)	Date/time attributes support standard equality, greater than, and less than checks against a java.sql.Timestamp.
Multi-valued Comparison Operators (contains, containsall)	Multi-valued attributes support a contains operator that takes an object of the attribute's subtype and checks that the attribute's value contains it. Additionally, multi-valued attributes support a containsall operator, which takes another collection of objects of the attribute's subtype and checks that the attribute's value contains all of them. Single-valued operators applied to a multi-valued attribute should cause the operator to be applied over the attribute's collection of values. Any value that matches the operator and operand should return true. For example, if the multi-valued text attribute keywords has the values BEA, Computer, and WebLogic and the operand is BEA, then the < operator returns true (BEA is less than Computer), the > operator returns false (BEA is not greater than any of the values), and the == operator returns true (BEA is equal to BEA).
User-defined Comparison Operators	Currently, no operators can be applied to a user-defined attribute.

 

Note: The search parameters and expression objects support negation (using !) of expressions via a bit flag.

Searchable Catalog Attributes

You can base your searches on the following attributes of the Product Catalog:

• sku

• identifier

• name

• shortDesc

• shortDescription

• description

• creator

• publisher

• contributor

• creationDate

• source

• lang

• language

• relation

• coverage

• rights

• format

• type

• inStock

• msrpCurrency

• msrpAmount

• priceCurrency

• priceAmount

• price

• estimateShipTime

• shipTime

• specialNotes

• notes

• taxCode

• shippingCode

• modifiedDate

Note: Some of the attributes have several aliases (for example, shortDesc and shortDescription, lang and language) but refer to a single attribute.

Controlling the Number of Search Results

The number of items returned from a keyword- or attribute-based search is controlled using the following APIs:

• getMaxSearchResults()

• setMaxSearchResults( int max )

These are methods on the com.beasys.commerce.ebusiness.catalog.
service.query.KeywordQuery and ProductItemQuery interfaces.

If an unlimited number of search results is desired, use:

setMaxSearchResults( CatalogQuery.ALL_RESULTS );

Limiting the number of search results returned prevents potentially very large result sets from being moved from the database to the JSP container. If the search query name like '*' is executed, all the items in the database will be returned. It may be desirable to limit the size of the result set to a suitably large number such as 1,000.

By default, the results from queries are not limited. As shown in Listing 5-35, the default search result size is controlled by the catalog.searchresults.size property in the wlcs-catalog.properties file. The file resides in the PORTAL_HOME\classes directory, where PORTAL_HOME is the directory in which you installed the WebLogic Portal software.

Listing 5-35 Using the wlcs-catalog.properties File to Control the Default Search Result Size

###############################################################################
#   Maximum search results returned by the catalog
#
#   You can dynamically change the searchresults by using the 
#   get/set MaxSearchResults methods on the CatalogQuery object
#
#   Set the value to -1 to return all results by the search engine
###############################################################################
catalog.searchresults.size=-1

 

---

Input Processors

This section provides a brief description of each Input Processor associated with the Product Catalog JSP templates.

CatalogIP

Class Name	examples.wlcs.sampleapp.catalog.webflow.CatalogIP
Description	Base InputProcessor for all Catalog-related InputProcessors. This abstract class contains global Catalog HTTP request parameter extraction and validation.
Required HTTPServletRequest Parameters	None
Optional HTTPServletRequest Parameters	HttpRequestConstants.CATALOG_VIEW_SIZE
Required Pipeline Session Properties	None
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_VIEW_SIZE (Request scope) only if CATALOG_VIEW_SIZE is given in the HTTPServletRequest.
Removed Pipeline Session Properties	None
Validation	Verifies that the CATALOG_VIEW_SIZE parameter is specified appropriately. Because view size is an optional parameter, no action is taken if it is not specified.
Exceptions	ProcessingException, thrown if the CATALOG_VIEW_SIZE is invalid.

 

ExpressionSearchIP

Class Name	examples.wlcs.sampleapp.catalog.webflow. ExpressionSearchIP
Description	Creates a ProductItemQuery based on a search expression HTTP request parameter and adds it to the Pipeline Session.
Required HTTPServletRequest Parameters	None
Optional HTTPServletRequest Parameters	HttpRequestConstants.CATALOG_SEARCH_STRING
Required Pipeline Session Properties	PipelineSessionConstants.CATALOG_QUERY. Required only if the CATALOG_SEARCH_STRING parameter does not exist.
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_QUERY
Removed Pipeline Session Properties	PipelineSessionConstants.CATALOG_SEARCH_RESULTS if the CATALOG_SEARCH_STRING parameter exists.
Validation	Verifies that the CATALOG_SEARCH_STRING parameter is a valid expression.
Exceptions	ProcessingException, thrown if the CATALOG_SEARCH_STRING parameter does not exist and the PipelineSessionConstants.CATALOG_SEARCH_RESULTS Pipeline Session property has expired. ProcessingException, thrown if the CATALOG_SEARCH_STRING parameter is invalid.

 

GetCategoryIP

Class Name	examples.wlcs.sampleapp.catalog.webflow.GetCategoryIP
Description	Creates a CategoryKey based on a category ID HTTP request parameter and adds it to the Pipeline Session. If no such parameter is supplied, the CategoryKey for the root category is added.
Required HTTPServletRequest Parameters	HttpRequestConstants.CATALOG_CATEGORY_ID
Optional HTTPServletRequest Parameters	None
Required Pipeline Session Properties	None
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_CATEGORY_KEY (Request scope)
Removed Pipeline Session Properties	None
Validation	Validates that the CATALOG_CATEGORY_ID parameter is valid.
Exceptions	ProcessingException, thrown if the CATALOG_CATEGORY_ID parameter is invalid.

 

GetProductItemIP

Class Name	examples.wlcs.sampleapp.catalog.webflow. GetProductItemIP
Description	Creates a ProductItemKey based on a product item SKU HTTP request parameter and adds it to the Pipeline Session.
Required HTTPServletRequest Parameters	HttpRequestConstants.CATALOG_ITEM_SKU
Optional HTTPServletRequest Parameters	None
Required Pipeline Session Properties	None
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_ITEM_KEY (Request scope)
Removed Pipeline Session Properties	None
Validation	Verifies that the CATALOG_ITEM_SKU parameter is valid.
Exceptions	ProcessingException, thrown if the CATALOG_ITEM_SKU parameter is invalid.

 

KeywordSearchIP

Class Name	examples.wlcs.sampleapp.catalog.webflow. KeywordSearchIP
Description	Creates a KeywordQuery based on a keyword search HTTP request parameter and adds it to the Pipeline Session.
Required HTTPServletRequest Parameters	None
Optional HTTPServletRequest Parameters	HttpRequestConstants.CATALOG_SEARCH_STRING
Required Pipeline Session Properties	PipelineSessionConstants.CATALOG_QUERY. Required only if the CATALOG_SEARCH_STRING parameter does not exist.
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_QUERY
Removed Pipeline Session Properties	PipelineSessionConstants.CATALOG_SEARCH_RESULTS, only if the CATALOG_SEARCH_STRING parameter exists.
Validation	Verifies that the CATALOG_SEARCH_STRING parameter is valid.
Exceptions	ProcessingException, thrown if the CATALOG_SEARCH_STRING parameter does not exist and the PipelineSessionConstants.CATALOG_SEARCH_RESULTS Pipeline Session property has expired. ProcessingException, thrown if the CATALOG_SEARCH_RESULTS parameter is invalid.

 

MoveAttributeIP

Class Name	examples.wlcs.sampleapp.catalog.webflow. MoveAttributeIP
Description	Sets Pipeline Session properties when moving a Pipeline Session property value from a source property to a destination property. The source and destination properties are specified as HTTP request parameters.
Required HTTPServletRequest Parameters	HttpRequestConstants.CATALOG_SOURCE_KEY HttpRequestConstants.CATALOG_DESTINATION_KEY
Optional HTTPServletRequest Parameters	None
Required Pipeline Session Properties	None
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_SOURCE_KEY (Request scope) PipelineSessionConstants.CATALOG_DESTINATION_KEY (Request scope)
Removed Pipeline Session Properties	None
Validation	Verifies that the CATALOG_SOURCE_KEY and the CATALOG_DESTINATION_KEY parameters are valid strings.
Exceptions	ProcessingException, thrown if either the source key or destination key is invalid.

 

RemoveAttributeIP

Class Name	examples.wlcs.sampleapp.catalog.webflow. RemoveAttributeIP
Description	Sets Pipeline Session properties for removing a Pipeline Session property value from a source property. The source property is specified as an HTTP request parameter.
Required HTTPServletRequest Parameters	HttpRequestConstants.CATALOG_SOURCE_KEY
Optional HTTPServletRequest Parameters	None
Required Pipeline Session Properties	None
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_SOURCE_KEY (Request scope)
Removed Pipeline Session Properties	None
Validation	Verifies that the CATALOG_SOURCE_KEY parameter is valid.
Exceptions	ProcessingException, thrown if the CATALOG_SOURCE_KEY parameter is invalid.

 

 

---

Pipeline Components

This section provides a brief description of each Pipeline Component associated with the Product Catalog JSP templates.

CatalogPC

Class Name	examples.wlcs.sampleapp.catalog.pipeline.CatalogPC
Description	Base PipelineComponent for all Catalog-related PipelineComponents. This abstract class contains Catalog-related Pipeline utility methods.
Required Pipeline Session Attributes	None
Optional Pipeline Session Properties	None
Updated Pipeline Session Properties	None
Removed Pipeline Session Properties	None
Type	Java object
JNDI Name	None
Exceptions	None

 

GetAncestorsPC

Class Name	examples.wlcs.sampleapp.catalog.pipeline.GetAncestorsPC
Description	Retrieves the ancestor Categories of the Category contained in the Pipeline Session CATALOG_CATEGORY property. The resultant Category array is placed into the Pipeline Session as the CATALOG_ANCESTORS property.
Required Pipeline Session Properties	PipelineSessionConstants.CATALOG_CATEGORY (Request scope)
Optional Pipeline Session Properties	None
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_ANCESTORS (Request scope)
Removed Pipeline Session Properties	None
Type	Java object
JNDI Name	None
Exceptions	PipelineException on Catalog finder error, Catalog general error, Catalog create error, or JNDI lookup error. This PipelineException is fatal, as specified in the Pipeline XML configuration file.

 

GetCategoryPC

Note: The GetCategoryPC2 Pipeline Component simply references the GetCategoryPC Pipeline Component, which is described in the following table.

Class Name	examples.wlcs.sampleapp.catalog.pipeline.GetCategoryPC
Description	Retrieves a Category based upon the CategoryKey in the Pipeline Session CATALOG_CATEGORY_KEY property. The resultant Category is placed into the Pipeline Session as the CATALOG_CATEGORY property.
Required Pipeline Session Properties	PipelineSessionConstants.CATALOG_CATEGORY_KEY (Request scope)
Optional Pipeline Session Properties	None
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_CATEGORY (Request scope)
Removed Pipeline Session Properties	None
Type	Java object
JNDI Name	None
Exceptions	PipelineException on Catalog finder error, Catalog general error, EJB create error, or JNDI lookup error. This PipelineException is fatal, as specified in the Pipeline XML configuration file.

 

GetParentPC

Class Name	examples.wlcs.sampleapp.catalog.pipeline.GetParentPC
Description	Retrieves the parent Category of the category contained in the Pipeline Session CATALOG_CATEGORY property. The resultant Category is placed into the Pipeline Session as the CATALOG_CATEGORY property.
Required Pipeline Session Properties	PipelineSessionConstants.CATALOG_CATEGORY (Request scope)
Optional Pipeline Session Properties	None
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_CATEGORY (Request scope)
Removed Pipeline Session Properties	None
Type	Java object
JNDI Name	None
Exceptions	PipelineException on Catalog finder error, Catalog general error, Catalog create error, or JNDI lookup error. This PipelineException is fatal, as specified in the Pipeline XML configuration file.

 

GetProductItemPC

Class Name	examples.wlcs.sampleapp.catalog.pipeline. GetProductItemPC
Description	Retrieves a ProductItem based upon the ProductItemKey contained in the Pipeline Session CATALOG_ITEM_KEY property. The resultant ProductItem is placed into the Pipeline Session as the CATALOG_ITEM property.
Required Pipeline Session Properties	PipelineSessionConstants.CATALOG_ITEM_KEY (Request scope)
Optional Pipeline Session Properties	None
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_ITEM (Request scope)
Removed Pipeline Session Properties	None
Type	Java object
JNDI Name	None
Exceptions	PipelineException on Catalog finder error, Catalog general error, Catalog create error, or JNDI lookup error. This PipelineException is fatal, as specified in the Pipeline XML configuration file.

 

GetProductItemsPC

Class Name	examples.wlcs.sampleapp.catalog.pipeline. GetProductItemsPC
Description	Retrieves the ProductItems associated with the Category contained in the Pipeline Session CATALOG_CATEGORY property. The resultant ViewIterator of ProductItems is placed into the Pipeline Session as the CATALOG_ITEMS property. The view size of the resultant ViewIterator may be specified with the optional CATALOG_VIEW_SIZE Pipeline Session property.
Required Pipeline Session Properties	PipelineSessionConstants.CATALOG_CATEGORY (Request scope)
Optional Pipeline Session Properties	PipelineSessionConstants.CATALOG_VIEW_SIZE (Request scope)
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_ITEMS (Request scope)
Removed Pipeline Session Properties	None
Type	Java object
JNDI Name	None
Exceptions	PipelineException on Catalog finder error, Catalog general error, Catalog create error, or JNDI lookup error. This PipelineException is fatal, as specified in the Pipeline XML configuration file.

 

GetSubcategoriesPC

Note: The GetSubcategoriesPC2 Pipeline Component simply references the GetSubcategoriesPC Pipeline Component, which is described in the following table.

Class Name	examples.wlcs.sampleapp.catalog.pipeline. GetSubcategoriesPC
Description	Retrieves the subcategories of the Category in the Pipeline Session CATALOG_CATEGORY property. The resultant ViewIterator of Categories is placed into the Pipeline Session as the CATALOG_CATEGORIES property. The view size of the resultant ViewIterator may be specified with the optional CATALOG_VIEW_SIZE Pipeline Session property.
Required Pipeline Session Properties	PipelineSessionConstants.CATALOG_CATEGORY (Request scope)
Optional Pipeline Session Properties	PipelineSessionConstants.CATALOG_VIEW_SIZE (Request scope)
Updated Pipeline Session Properties	PipelineSessionConstants.CATALOG_CATEGORIES (Request scope)
Removed Pipeline Session Properties	None
Type	Java object
JNDI Name	None
Exceptions	PipelineException on Catalog finder error, Catalog general error, EJB create error, or JNDI lookup error. This PipelineException is fatal, as specified in the Pipeline XML configuration file.

 

MoveAttributePC

Class Name	examples.wlcs.sampleapp.catalog.pipeline.MoveAttributePC
Description	Moves a Pipeline Session property value from a source property (attribute) to a destination property. The source and destination property are specified by the CATALOG_SOURCE_KEY and CATALOG_DESTINATION_KEY Pipeline Session property.
Required Pipeline Session Properties	PipelineSessionConstants.CATALOG_SOURCE_KEY (Request scope) PipelineSessionConstants.CATALOG_DESTINATION_KEY (Request scope)
Optional Pipeline Session Properties	None
Updated Pipeline Session Properties	Both request-scoped and session-scoped Pipeline Session properties keyed by the CATALOG_DESTINATION_KEY Pipeline Session property.
Removed Pipeline Session Properties	Both request-scoped and session-scoped Pipeline Session properties keyed by the CATALOG_SOURCE_KEY Pipeline Session property.
Type	Java object
JNDI Name	None
Exceptions	None

 

PriceShoppingCartPC

Class Name	examples.wlcs.sampleapp.shoppingcart.pipeline. PriceShoppingCartPC
Description	Invokes the Pricing Service to price each of the shopping cart lines and compute the subtotal.
Required Pipeline Session Properties	PipelineSessionConstants.SHOPPING_CART
Optional Pipeline Session Properties	PipelineSessionConstants.USER_NAME
Updated Pipeline Session Properties	None
Removed Pipeline Session Properties	None
Type	Java object
JNDI Name	None
Exceptions	PipelineException on price service JNDI lookup error or remote error. This PipelineException is fatal, as specified in the Pipeline XML configuration file.

 

RemoveAttributePC

Class Name	examples.wlcs.sampleapp.catalog.pipeline. RemoveAttributePC
Description	Removes a Pipeline Session property (attribute) value from a source property. The source property is specified by the CATALOG_SOURCE_KEY Pipeline Session properties.
Required Pipeline Session Properties	PipelineSessionConstants.CATALOG_SOURCE_KEY (Request scope)
Optional Pipeline Session Properties	None
Updated Pipeline Session Properties	None
Removed Pipeline Session Properties	Both request-scoped and session-scoped Pipeline Session properties keyed by the CATALOG_SOURCE_KEY Pipeline Session property.
Type	Java object
JNDI Name	None
Exceptions	None

 

SearchPC

Class Name	examples.wlcs.sampleapp.catalog.pipeline.SearchPC
Description	Performs a Catalog query based upon the CatalogQuery in the Pipeline Session CATALOG_QUERY attribute. The resultant ViewIterator of ProductItems is placed into the Pipeline Session as the CATALOG_SEARCH_RESULTS attribute. The view size of the resultant ViewIterator may be specified with the optional CATALOG_VIEW_SIZE Pipeline Session attribute.
Required Pipeline Session Attributes	PipelineSessionConstants.CATALOG_QUERY (Request scope)
Optional Pipeline Session Attributes	PipelineSessionConstants.CATALOG_VIEW_SIZE (Request scope)
Updated Pipeline Session Attributes	PipelineSessionConstants.CATALOG_SEARCH_RESULTS
Removed Pipeline Session Attributes	None
Type	Java object
JNDI Name	None
Exceptions	PipelineException on Catalog finder error, Catalog general error, EJB create error, or JNDI lookup error. This PipelineException is fatal, as specified in the Pipeline XML configuration file.