Skip Headers

Oracle iStore Implementation and Administration Guide
Release 12.1
Part Number E13575-06
Go to Table of Contents
Contents
Go to previous page
Previous
Go to next page
Next

Implementing the Catalog

This chapter covers the following topics:

Overview of Implementing the Catalog Chapter

This chapter contains information on implementing the Customer Application product catalog in Oracle iStore, including creating the section hierarchy and adding products to the sections.

Understanding Customer Application Page Display

Oracle iStore utilizes JavaServer Pages (JSPs), which combine Application Programming Interfaces (APIs) to call dynamic data and HTML to present static data. A robust PL/SQL layer interfaces with the Oracle database to provide consistent and accurate data storage and retrieval.

In the Customer Application, each web page is made up of an overall JSP (for example the seeded Site Home Page, ibeCZzpHome.jsp) that calls other JSPs to display the various areas of the page. Oracle iStore uses templates and other components to present the Customer Application, including:

Although many customers do customize Oracle iStore, given the application's range of configuration options, customizing is not necessary.

Display Templates Overview

This section contains general information on Display Template functionality within Oracle iStore.

Display Templates Present the Customer Application

Oracle iStore is supplied with over 800 Display Templates that present the Customer Application pages. In addition, you can create your own templates for use in the sites. Each template has a specific display purpose, depending upon which element of the customer-facing application it displays. The template categories are known as Applicable To categories in the Site Administration Application.

In order for a Display Template to present an element of the Customer Application, it must link to a source file --- this is where its content comes from. This source file typically is a Java Server Page (JSP). The seeded Display Templates that present the default Customer Application are linked to source JSPs. Other templates are left without source JSP files, so that you can configure your own Customer Application presentation with your own source JSPs.

Many of Oracle iStore's Display Templates can call logical media objects and content components to present image and HTML content. These can be any type of image file, such as .gif, .jpg, .bmp, etc., or HTML content in the form of .htm files. Some of the Display Templates present this type of content by calling seeded content components that are located within them. To map content, you must link content components to a logical media object, which you in turn map to the physical source content file (.gif, .htm, etc.). Each Display Template, depending upon its usage, contains the programmatic access names of specific content components. It uses these programmatic access names to call the components. Other Display Templates can call media objects directly. Some section Display Templates can understand content as well.

See the appendix, Seeded Display Data, for a list of templates and categories.

Display Template Characteristics

Display Templates have the following features:

Creating New Display Templates

You also can register your own templates to link with your own JSP files, in order to customize the presentation of the Customer UI display. See the chapter, Advanced Display, for details.

Note: During upgrades, Oracle iStore does not alter custom templates and their JSP mappings, nor does it overwrite mappings of JSP files to specific site-language combinations.

Importing or Exporting Display Template Mappings

Oracle iStore's Display Template Mappings Import/Export functionality for Template Manager allows you to transfer template mappings between instances using XML files. See the chapter, Advanced Display, for details.

Catalog Overview

The catalog you build using Oracle iStore's sections and products allows you organize your sites into hierarchal sections with products, and to re-use the sections, their products, and any associated content, in one or multiple sites. You also can choose to exclude specific sections, subsections, or products from sites.

In combination with the Display Templates, your site sections --- connected in a parent-child fashion --- help determine the browsing path for the customer in your Customer Application specialty sites. All driven from the main Root section, together the sections, subsections, and products in your sites form a tree-like structure with which you organize and present your product catalog.

Use the Sections and Products pages within the Catalog tab in the Site Administration Application to perform section-product creation and maintenance tasks.

Using the Sections pages, you can:

For more information on products, see the chapter, Implementing Products.

Implementing Sections

In your initial implementation, the section hierarchy will consist of a single parent node, called Root. To this single node, you can add as many subsections as you wish, as long as you follow certain rules for section type (see the "Section Types" section). Your products "hang" upon the sections and subsections of the hierarchal tree.

Each site points to a single node of the section hierarchy. This node is known as the site's root section -- the site root section can be either the main (initial) Root node or one of the other main or subsections that you create. In the specialty sites that include the section, the sites' navigation is driven from the first top-level section in the hierarchy.

Catalog Hierarchy Guidelines and Behavior

Consider the following guidelines and behavior when building the section-product hierarchy:

You can find more information in the following sections:

Section Types

Site sections are of two basic types: Featured and Navigational. A third category, Leaf, can be of either main type, depending upon its placement in the hierarchy. See below for details.

Featured section:

Navigational section:

Leaf section:

Within these two types, a section also can be characterized as a Leaf section. Following are the Leaf section characteristics:

Note that a Leaf section is a logical definition, and not a section attribute that you can define in Oracle iStore.

See the chapter, Implementing Products, for more details.

Section Statuses

Before a section is available to customers in the Customer Application, you must flag the section as Published and save the changes. Unpublished sections cannot be seen by customers.

Product Status

While working with the product catalog, you can determine whether or not to change the status of an Oracle Inventory product to Published or Unpublished. Only published products are able to display in the Customer Application, unless the site administrator is using Preview mode.

Setting a product's Published/Unpublished status in the Oracle iStore Site Administration Application is the same as changing the product's Web Status setting in Oracle Inventory.

Below are the definitions of the two Oracle iStore product statuses:

Note: Oracle Inventory allows users to set a Web Status of Disabled. Products in status, Disabled, cannot be queried in the Site Administration Application nor assigned to sections. Setting a product's Web Status to Disabled in Inventory will make products disappear in both the Site Administration and Customer UIs.

Understanding Section Display

Sections and their associated products display in the Customer Application in the context of the Display Templates in which they appear. All of the section templates appear in the center of the Customer Application screen. In addition to the Display Templates, section appearance is affected by the structure of your section hierarchy, any section-product associations, any content you have associated to a section or product, and any bins configured for the pages.

Section and Product Display Profile Options

Several profile options control how sections and products appear in the specialty site sections. These are discussed in this section.

Setting the Number of Home Page Tabs and Subtabs

Top-level sections of a site's root node become tabs across the top of the Site Home Page. The second-level sections become the subtabs across the top of the Site Home Page.

The number of tabs and subtabs is controlled by these profile options:

Setting the Number of Child Sections Per Page

The profile option, IBE: Sections Per Page for Display, allows you to set the maximum number of subsections to display on a page before the subsections fall to a new page. See the appendix, Profile Options, for more information.

Displaying the Section Path

The profile option, IBE: Use Section Path, determines whether the section path displays in those catalog templates which can display a section path. See the appendix, Profile Options, for more information.

Displaying Bins with Seeded Content

Three bins with seeded JSP content are controlled by profile options when using Fixed Layout for sections. These bins are:

See the chapter, Implementing Initial Customer Application Pages, for more information.

Displaying a Set Number of Items in Leaf Sections

The profile option, IBE: Items Per Page for Display, specifies number of items to display in Leaf sections of the hierarchy (the ending sections of a node). See the appendix, Profile Options, for more information.

Displaying a Set Number of Items in Sections

The profile option, IBE: Items Per Section for Display, specifies the number of items to display in sections of the hierarchy that contain products. See the appendix, Profile Options, for more information.

Displaying a Set Number of Items in Multiple-Section Template

The profile option, IBE: Lines Per Section for Multiple Section Display, specifies the number of items to display per section in Display Templates that show multiple sections. See the appendix, Profile Options, for more information.

Section Templates Overview

The structure of your catalog sections as they display on Customer Application pages is determined by your layout and template choices for the sections. To aid your understanding of the options involved, following is a process flow for building section structure.

Process Flow for Building Section Structure

In this process, you associate each section to:

and

Note that it is optional to configure section structure. You can always accept the default layout and default templates.

  1. Select Layout Template: First, determine which Layout Template to use for each section. This is done in the Update Section: Layout page. The options for layout template are:

  2. Select Display Template: Next, select a Display Template for the section(s). This is done in the Update Section: Template page.

    Display Template options are:

  3. Map Bins to Content: You can implement bins on the section pages to present content along the top, bottom, right, and left of your catalog pages. If using Configurable Layout, each section can have unique bin locations. If using Fixed Layout, all mapped bins display in the same location on all section pages using the same Display Template. See the section, "Configuring Bin Placement and Content", within this chapter, for steps detailing how to map bins to content, after you have selected either Fixed or Configurable Layout in the Update Section: Layout page.

Section Templates

Within the Oracle iStore Display Templates are those that display only sections and their related information. Display Templates allow Customer UI users to see such information as section name and description, links to subsections, and content (images or HTML files).

Overview of Section Template Categories

Templates are categorized by the type of section they display. The section category is known as the Applicable To category of the template. The categories are:

See the sections: "Applicable To Categories for Display Templates Associated with Fixed Layout" and "Applicable To Categories for Display Templates Associated with Configurable Layout", below, for more information.

Fixed Versus Configurable Layout with Section Display Templates

For each section, you can select Fixed or a Configurable layout for Display Templates. See the section, "Process Flow for Building Section Structure", within this chapter, to gain an understanding of the typical flow for building section structure.

The primary difference between the two layouts are:

Fixed Layout:

Configurable Layout:

Note that section templates in the Fixed Layout gallery have the same look and feel as those in the Configurable Layout gallery -- the same template look and feel that is available in the Fixed Layout gallery is similarly available in the Configurable Layout gallery. Templates within Fixed and Configurable layout are different templates, but each template for Fixed Layout has a corresponding Configurable Layout template with same appearance.

Important: In the Site Administration Application, you must first select the layout type (Fixed or Configurable) and then select a template for the section.

Applicable To Categories for Display Templates Associated with Fixed Layout

Three Applicable To categories exist within the Display Templates associated with Fixed Layout. These are:

Note: For backward compatibility purposes, a fourth category exists: Uncategorized section display templates. This category is for templates which have been migrated during an upgrade.

Applicable To Categories for Display Templates Associated with Configurable Layout

Three Applicable To categories exist for Display Templates associated with Configurable Layout. These are:

Templates for Section Contains Featured Subsections Category

With this category, the section itself also can have other Navigational subsections. For this type of template, the main (parent) section itself is never rendered, because when the user selects the parent section, the page flow automatically routes the user to the Featured subsection.

The following section templates are in this category:

Product Detail

This template shows:

Programmatic access name --- STORE_CTLG_FSUBSCT

Default mapped JSP --- ibeCCtpFSubSct.jsp

The following graphic shows how the template appears in the gallery.

Product Detail Section Display Template

the picture is described in the document text

Note: This also is the default template for this category (Section Contains Featured Subsections).

Product Multi-Select

This template shows:

Programmatic access name --- STORE_CTLG_FSUBSCT_MULT_2COL

Default mapped JSP --- ibeCCtpFSuStMs2.jsp

The following graphic shows how the template appears in the gallery.

Product Multi-Select Section Display Template

the picture is described in the document text

Note: If you use this section Display Template, you must change the seeded text message that displays. See the section, "Setting up Section Display Templates Text Messages", below, for more information.

Product Multi-Select with Section Links

This template shows:

Programmatic access name --- STORE_CTLG_FSUBSCT_MULT_3COL

Default mapped JSP --- ibeCCtdFSuStMs3.jsp

The following graphic shows how the template appears in the gallery.

Product Multi-Select with Section Links Section Display Template

the picture is described in the document text

Note: If you use this section Display Template, you must change the seeded text message that displays. See the section, "Setting up Section Display Templates Text Messages", below, for more information.

Templates for Section Contains Navigational Subsections Only Category

The following section templates are applicable to those sections which contain Navigational subsections only:

These templates are described in the sections that follow.

Subsection List

This template shows:

Programmatic access name --- STORE_CTLG_SCT_BULLET_SUBSCT

Default mapped JSP --- ibeCCtpStBlSuSt.jsp

The following graphic shows how the template appears in the gallery.

Subsection List Section Display Template

the picture is described in the document text

Note: This is also the default section template for this category (Section Contains Navigational Subsections Only).

Subsection List 2

This template shows:

Programmatic access name --- STORE_CTLG_SCTN_BULLET_SUBSCT

Default mapped JSP --- ibeCCtpStNBlSuSt.jsp

The following graphic shows how the template appears in the gallery.

Subsection List 2 Section Display Template

the picture is described in the document text

Multilevel Subsection List

This template shows:

Programmatic access name --- STORE_CTLG_DLDN_SCT_BULLET

Default mapped JSP --- ibeCCtpDdLfStBl.jsp

The following graphic shows how the template appears in the gallery.

Multi-Level Subsection List Section Display Template

the picture is described in the document text

Subsection List with Product Detail

This template shows:

Programmatic access name --- STORE_CTLG_DRILL_LEAF

Default mapped JSP --- ibeCCtpDrillLeaf.jsp

The following graphic shows how the template appears in the gallery.

Subsection List with Product Detail Section Display Template

the picture is described in the document text

Subsection List with Product Pull-Down List

This template shows:

Programmatic access name --- STORE_CTLG_SUBSCT_DPDN_ITEMS

Default mapped JSP --- ibeCCtpChStDdIts.jsp

The following graphic shows how the template appears in the gallery.

Subsection List with Product Pull-Down Section Display Template

the picture is described in the document text

Templates for Section Contains Products Only Category

The following section templates are applicable to those sections which contain only products:

These templates are described in the sections that follow.

Product Detail

This template shows:

Programmatic access name --- STORE_CTLG_LEAF_SCT_SINGLE

Default mapped JSP --- ibeCCtpLeafSctSs.jsp

The following graphic shows how the template appears in the gallery.

Product Detail Section Display Template

the picture is described in the document text

Note: This is also the default section template for this category (Section Contains Products Only).

Product Pull-Down

This template shows:

Programmatic access name --- STORE_CTLG_SCT_DTL_DPDN_ITEMS

Default mapped JSP --- ibeCCtpStMmDtIts.jsp

The following graphic shows how the template appears in the gallery.

Product Pull-Down Section Display Template

the picture is described in the document text

Product Detail Multi-Select

This template shows:

Programmatic access name --- STORE_CTLG_LEAF_SCT_ITEMS

Default mapped JSP --- ibeCCtpLfStIts.jsp

The following graphic shows how the template appears in the gallery.

Product Detail Multi-Select Section Display Template

the picture is described in the document text

Product Multi-Select

This template shows:

Programmatic access name --- STORE_CTLG_LF_SCT_MULT_NOLINKS

Default mapped JSP --- ibeCCtpLfStMs.jsp

The following graphic shows how the template appears in the gallery.

Product Multi-Select Section Display Template

the picture is described in the document text

Product Multi-Select with Drill-Down

This template shows:

Programmatic access name --- STORE_CTLG_LEAF_SCT_MULTIPLE

Default mapped JSP --- ibeCCtpLfStMsL.jsp

The following graphic shows how the template appears in the gallery.

Product Multi-Select with Drill-Down Section Display Template

the picture is described in the document text

Templates for Component for Sections Contain Nav. Subsec. Only Category

Within the configurable layout option, the following section templates are applicable to those sections which contain Navigational subsections:

Multilevel Subsection List with Content

This template is specifically designed to show subsections within a section, along with content mapped to content components at the section level. This template shows:

Programmatic access name --- STORE_SECT_MULTILEVEL_SUBSECT_INCL

Default mapped JSP --- ibeCCtdStMlSubStI.jsp

The following graphic shows how the template appears in the gallery.

Multilevel Subsection List with Content Section Display Template

the picture is described in the document text

Templates for Component for Sections Containing Products Only Category

Within the Configurable Layout option, the following section templates are applicable to those sections which contain only products:

Section Detail

This template is specifically designed to show section details, along with content mapped to content components at the section level. This template shows:

Programmatic access name --- STORE_SECT_DETAIL_INCL

Default mapped JSP --- ibeCCtdStDetI.jsp

The following graphic shows how the template appears in the gallery.

Section Detail Section Display Template

the picture is described in the document text

Product Templates

Within the Oracle iStore Display Templates are those that display products. Of course, since products only appear within the context of a section, the overall structure around the product display is affected by the section Display Templates.

This section lists the seeded templates for products:

These templates are described in the sections that follow.

For information on how to assign templates, see the "Setting Display Templates for Products", below.

Product Additional Information

Use this template to display Featured products in a Featured section.

Programmatic access name --- STORE_CTLG_ITEM_INFO

Default mapped JSP --- ibeCCtdItemInfo.jsp

Note: This is a migrated Display Template which appears in the Custom Display Template LOV in the Template Gallery of the Products, Display Template page. No image of this template displays in the Template Gallery.

Product Basic Information

This template shows:

Programmatic access name --- STORE_CTLG_ITEM_DESC

Default mapped JSP --- ibeCCtdItemDesc.jsp

The following graphic shows how the template appears in the gallery.

Product Basic Information Display Template

the picture is described in the document text

Product Basic Information with Image

This template shows:

Programmatic access name --- STORE_CTLG_ITEM_DESC_AND_IMG

Default mapped JSP --- ibeCCtdItemDescImg.jsp

The following graphic shows how the template appears in the gallery.

Product Basic Information with Image Display Template

the picture is described in the document text

Product Detail with Image

This template shows:

Programmatic access name --- STORE_CTLG_ITEM_DETAILS

Default mapped JSP --- ibeCCtdItemDetail.jsp

Note: This also is the default Display Template for products.

The following graphic shows how the template appears in the gallery.

Product Detail with Image Display Template

the picture is described in the document text

Product Detail without Image

This template shows:

Programmatic access name --- STORE_CTLG_ITEM_DETAILS_NO_IMG

Default mapped JSP --- ibeCCtdItemDtlNoImg.jsp

The following graphic shows how the template appears in the gallery.

Product Detail without Image Display Template

the picture is described in the document text

Product Detail with Services

This template is specifically designed to display service items. This template shows:

Programmatic access name --- STORE_CTLG_SVA_SVC_LIST

Default mapped JSP --- ibeCCndSvaSvcList.jsp

The following graphic shows how the template appears in the gallery.

Product Detail with Services

the picture is described in the document text

Creating and Maintaining Sections

This section contains information on section creation and maintenance.

See the section, "Configuring Bin Placement and Content", within this chapter, for information on how you can implement bins to surround your section Display Templates with additional JSPs and content.

Note: All of the steps in this section assume you will log in to the Oracle iStore Site Administration Application as the iStore administrator.

For product maintenance tasks in the context of sections, see the section, "Maintaining Products in Sections", within this chapter.

Note on Categories page within the Section pages: The Categories page within the Sections menu is used for Oracle iStore's Product Autoplacement functionality only. See the chapter, Implementing Products, for more information.

Creating Sections

Using the Sections pages within the Site Administration Application Catalog tab, you can create as many sections as you wish. In the Sections summary page, Catalog Hierarchy, you can use the Focus icon located next to section names to focus in on and work with a particular section or a section and its children.

To create a section, log in to the Site Administration Application and select Catalog, then Sections , then Create Section icon (in the Sections column).

Create Section Icon

the picture is described in the document text

Guidelines

The following guidelines can assist you when creating sections:

Deleting Sections

You can delete a section at any time by selecting the section in the Catalog Hierarchy page and then pressing the Delete button. When you delete a section, all children (subsections or products) are removed.

Note: You cannot delete a section from the section hierarchy if that section or its child sections are being used as a root section for a site.

Duplicating Sections

The Catalog Hierarchy page within the Sections menu features the ability to duplicate any existing section or subsection.

To duplicate a section, log in to the Site Administration UI and select Catalog, then Sections; select a section and press Duplicate.

Important: If you try to duplicate a section that has more than 1,000 subsections as children, Oracle iStore does not complete the process and displays an error message. If you have more than 1,000 subsections, use the iStore Duplicate Section concurrent program. After running this concurrent program, you can then run the iStore Section Layout Mapping program to copy the content mapping of the newly duplicated section to all of its child sections. See the "iStore Duplicate Section Concurrent Program" and "iStore Section Layout Mapping Concurrent Program" sections, below, for more details.

Guidelines

iStore Duplicate Section Concurrent Program

Use this program to copy a section which has a large number (e.g., more than 1,000) children sections. Following are the parameters:

Remember to submit the request after entering parameters.

iStore Section Layout Mapping Concurrent Program

The iStore Section Layout Mapping concurrent program lets you copy all of the layout mappings (bins) from a Configurable Layout parent section to its children. To run this program, in the Section Name field, enter the name of the section whose layout bins content will be mapped to the child sections.

Note: This concurrent program only works with sections using Configurable Layout.

Remember to submit the request after entering parameters.

Cascade Section Layout Mapping to Children Example

Section A has multiple bins mapped using Configurable Bin Layout. You wish to copy these bin mappings to all of its child sections. Log into Oracle Forms and run the iStore Section Layout Mapping concurrent program, choosing the parent section in the Section Name field. After the concurrent program is run, all of the bins mapped to the parent section will be mapped to the children sections.

Adding Products to Sections Using the Sections Pages

Within the Site Administration Application Catalog tab, you can add products to a section either through the Sections pages or through the Products pages. This section contains information about adding products to sections in the Sections pages. For instructions on how to assign sections to a single product using the Products pages, see the section, "Adding Products to Sections Using the Products Pages".

You also can use Oracle iStore's Product Autoplacement feature to automatically add products to leaf sections; see the chapter, Implementing Products, for details.

To add one or several products at once to a single section, log in to the Site Administration Application and select Catalog, then Sections > (select section), then Update, then Add Products icon.

Add Products Icon

the picture is described in the document text

Guidelines

Assigning Sections to Sites

A section must be assigned to a site in order to display in the Customer Application.

To assign a section to a site, log in to the Site Administration Application and select Catalog, then Sections (select section), then Update, then the Sites hyperlink.

Guidelines

Adding Content to Sections

You can use Oracle iStore's content components and media object functionality --- in combination with your own content source files --- to add content to sections. See the chapter, Implementing Content, to learn the basics of how Oracle iStore can display content in your specialty sites.

To add content to a section, log in to the Site Administration Application and select Catalog, then Sections (select section), then Update, then the Content hyperlink.

Guidelines

Selecting Layout and Setting Display Templates for Sections

Display Templates control the appearance of your site sections, and each section can have its own Display Template mapping.

To set the Display Template for a section, log in to the Site Administration Application and Select Catalog, then Sections (select section), then Update, then the Templates hyperlink. Within section templates functionality, you have the choice of using either Fixed or Configurable layout -- first you choose the layout type, then select a template from the gallery available within each layout type.

Guidelines

Setting the Display Order of Section Descendants

You can set the display order of a section's descendant sections -- whether subsections or products. This allows you to re-arrange the order of subsections or products in the Customer Application without customization.

To set the display order for a section or product, log in to the Site Administration Application and select Catalog, then Sections (select section), then Update, then the Display Order hyperlink.

Guidelines

Using SQL to Order Section Descendants

Advanced users may wish to use the Update Section: Display Order - Order by Clause page in the Sections menu to order products in a Featured section.

To re-order a section's descendants using an SQL clause, log in to the Site Administration Application. Select Catalog, then Sections (select section) , then Update, then the Display Order hyperlink.

Guidelines

Example -- A Section's Order By Clause

The following order by clause sorts items by creation date in descending order and description in ascending order: CREATION_DATE DESC, DESCRIPTION ASC

Using the Section Search Utility

Using the section search utility, you can perform Simple or Advanced searches of the section hierarchy.

To use section search, log in to the Site Administration Application. Select Catalog, then Sections. Select the Advanced button for advanced search.

Guidelines

Maintaining Products in Sections

This section contains information on maintaining products within the section hierarchy. This section assume you will log in to the Oracle iStore Site Administration Application as the iStore Administrator.

Product implementation and limited maintenance information can be found in the chapter, Implementing Products.

Optional integration with Oracle Marketing can provide enhanced product functionality. See the chapter, Integrating Oracle iStore with Oracle Marketing, for details.

Previewing Products

Oracle iStore's Preview mode allows site administrators to preview products in the context of the specialty site(s) that include the products. Typically, Preview mode is accomplished by pressing the Preview button on applicable screens in the Site Administration Application.

All products -- whether of published or unpublished status --- will display in Preview mode. You cannot perform any transactions while in Preview mode.

Note: In Preview mode, only specialty sites which support the administrator's current session language will display. Also, Preview mode is not supported when accessing the Customer Application through Oracle Application Server Web Cache. See the chapter, Verifying the Implementation, for more information.

Updating Product Details

In the Site Administration Application, you can update a product's basic information and set the Web Status (Published/Unpublished) flag.

To update a product, log into the Site Administration Application and select Catalog, then Products (select product), then Update.

Adding Products to Sections Using the Products Pages

You can add a single product to multiple sections at the same time.

To add a product to section(s), log in to the Site Administration Application and select Catalog, then Products, (select product), then Update, then the Sections hyperlink.

Guidelines

Including or Excluding Products from Sites

By default, products are included in all sites which their parent section belongs to. However, you can exclude or include a product in specific site(s).

To include/exclude products from sites, log in to the Site Administration Application. Select Catalog, then Products, then the Sites hyperlink.

If the profile option, IBE: Use Catalog Exclusions, is set to No, the products will still show up in excluded sites. Be sure to set the profile option to Yes for the exclusion functionality to work properly.

Setting Content at the Product Level

Just as you can with sections, you can add content to a product template using Oracle iStore's content component and media object functionality. Content mapped at the product level overrides all other mappings.

See the chapter, Implementing Content, for more information on content concepts.

To add content at the product level, log in to the Site Administration Application and select Catalog, then Products (select product), then Update, then the Content hyperlink.

Guidelines

When adding content to products, the same basic guidelines that apply to section content apply as well. See the section, "Adding Content to Sections", within this chapter, for more information.

For the types of templates that can display product information, see the section, "Product Templates", within this chapter.

Setting Display Templates for Products

Just as with sections, you can assign Display Templates to products to determine the layout and display elements surrounding the product.

To assign a Display Template to a product, log in to the Site Administration UI and select Catalog > Products > (update product) > Display Template hyperlink.

Searching for Products

Site administrators must search for products before they display in the Products Summary page. Both Simple and Advanced product searches are available.

To Log into the Site Administration Application and select Catalog, then Products.

Guidelines

Configuring Bin Placement and Content

The Oracle iStore Customer Application catalog pages are sectioned into several templates that function as bins. These bins can hold specific information (in the form of JSP files) and display it logically on the pages (left, right, top, bottom, and in some cases, middle page area). Some of the bins by default are mapped to supplied JSP files -- examples include the Browse Bin, the Global Bin, and the Welcome Bin. Others are left unmapped so that you can map your own JSP files. Of course, you also can change a seeded JSP mapping for a bin.

Bins Overview

Page types that have bins include:

For a complete list of supplied bins, see the appendix, Seeded Display Data.

All bins are separate logical Display Templates available through Oracle iStore Template Manager; each has a display name and programmatic access name. The programmatic access name is used by Oracle iStore Display Manager at runtime to find mapped bin content (the JSP file).

Other Guidelines

Keep the following additional guidelines in mind:

Configurable and Fixed Layout Available

Section page bins can be configured in two ways -- using Fixed Layout, where every catalog section page using the same Display Template shows the mapped bins in the same location on every page, or using Configurable Layout, where bins can be placed on the page of a specific section and in a specific location.

See the following topics within this section for more information:

Summary of Options for Changing Bin Placement and Content

You can change bin placement or content in the following ways:

Using Fixed Bin Layout

With Fixed Layout, all sections using the same Display Template share the same bin layout. For example, if you map the section bin, STORE_CTLG_BIN_LEFT_1 template, to a JSP, then all section pages using the same template show the mapping for this bin in the same location. Of course, you can map different JSPs to site-language combinations to vary the content by site and language.

Section Page Bins

In addition to the seeded Browse Bin, Global Bin, Welcome Bin (which have seeded content and display automatically), the section pages contain seven bins to the right and seven bins to the left of the center display page, as well as a top bin and a bottom bin. These bins do not have seeded content.

Following is a summary of the section bin layout:

The section bins with seeded content can be turned on or off through profile options, when using fixed section layout.

To copy bin mappings from a parent section to all of the children of the section, use the iStore Section Layout Mapping concurrent program.

Item Detail Page Bins

Item bins display along the sides, top, and bottom of the web page when a user views an item detail template. All seeded item bin templates share the same layout. You can customize the common item layout through profile option settings and template setup (in addition to this section, see the sections, "Section and Product Display Profile Options", and "Product Templates"). None of the item bins has a seeded JSP mapped.

Following is a summary of the item bins:

Shopping Cart Page Bins

The Shopping Cart page contains bins which you can customize. None of the cart bins has a seeded JSP mapped.

Following is a summary of the shopping cart page bins:

Registration Page Bins

The New User Registration page (ibeCRgdRegContainer.jsp) and subsequent registration information pages contain bins which you can customize. None of the registration page bins has a seeded JSP mapped.

Following is a summary of the registration page bins:

Fixed Layout Bin Locations

The following graphic shows the default location for the Fixed Layout bin locations.

Fixed Layout Bin Locations

the picture is described in the document text

Using Configurable Bin Layout

Oracle iStore's Configurable Layout functionality allows you to display targeted bin content in different sections. See also: "Fixed Versus Configurable Layout with Section Display Templates" within this chapter.

Configurable Bin Layout Benefits and Behavior

The following points describe Configurable Layout benefits and behavior:

Remember, you can associate a Display Template to a section only through the Display Template gallery.

Layout Components for Configurable Bin Layout

Following are the layout components available in Configurable Layout:

The following figure shows the location of the components available in Configurable Layout.

Component Locations in Configurable Layout

the picture is described in the document text

Configurable Bin Layout Steps

Use the following procedure to set up a section using Configurable Layout components. See the section, "Selecting Layout and Setting Display Templates for Sections", for information on using the Fixed Layout feature.

Log in to the Site Administration Application and select Catalog, then Sections (select section), then Templates, then Layout, then Configurable Layout.

Guidelines

Group Bins

After assigning specialty sites to groups, you can set up bins which allow navigation to the specialty sites within the groups, by mapping the bins to the section pages of your choice using Configurable Layout. Oracle iStore seeds a group bin for each of these groups: Stores, Support, Partners.

Following is the high-level process:

See also: Integrating Oracle iStore with Oracle iSupport, and Integrating Oracle iStore with Oracle Partner Management

The following figure shows an example of how the Stores group bin might look in an implementation of Oracle iStore.

Stores Group Bin Example

the picture is described in the document text

Custom Group Bins

If you have created a custom group, you can set up a bin for the custom group. Following is the high-level process.

Mapping Source Files to Display Templates

Each template or bin used in the Customer UI must be mapped to a source JSP in order for it to display content.

To map JSP content to existing templates, log in to the Site Administration Application and select Advanced, then Template Manager, then Update icon, then Add Source File.

Prerequisites

Guidelines

Setting up Section Display Templates Text Messages

Two seeded Oracle iStore section Display Templates come with three non-usable FND_MESSAGES seeded as part of their display. If you use either of these section templates and their associated JSPs in a specialty site, you will want to change the seeded text messages.

The template gallery in the Sections pages display these templates as:

If not altered, the seeded text messages will appear in these two templates as:

The following table summarizes the names of the template JSP source files, their programmatic access names, and their descriptions.

Section Templates Requiring Text Message Setup
Source File (JSP) Programmatic Access Name Description
ibeCCtdFSuStMs2I.jsp STORE_CTLG_FSUBSCT_MULT_2COL_ INCL Non-leaf section featured products with multiple select two columns
ibeCCtdFSuStMs3I.jsp STORE_CTLG_FSUBSCT_MULT_3COL_ INCL Non-leaf section featured products with multiple select three columns

The following table summarizes the referenced source files (JSPs), the seeded message display text, and the seeded programmatic access names for the seeded messages.

Text Messages for Section Templates Requiring Text Message Setup
Seeded Message(s) Display Text Source File (JSP) Programmatic Access Name
Enter product header 1 alternative 2
(Displays at the top of the left-hand column.)
ibeCCtdFSuStMs2I.jsp IBE_PRMT_CT_PRODUCT_HDR1_ALT2
Enter product header 1 alternative 1
(Displays at the top of the left-hand column.)
ibeCCtdFSuStMs3I.jsp IBE_PRMT_CT_PRODUCT_HDR1_ALT1
Enter product header 3 alternative 1
(Displays at the top of the right-hand column)
ibeCCtdFSuStMs3I.jsp IBE_PRMT_CT_PRODUCT_HDR3_ALT1

Stored in Oracle Applications Message Dictionary, these messages are seeded in the FND_NEW_MESSAGES table. See the chapter, Implementing Messages and Prompts, for steps to modify the messages.

Using Product Relationships

Product relationships potentially allow you to increase sales by creating associations between products. You can use the seeded relationship type, Related, to offer a related product to a customer. In the Customer UI product detail pages, the relationships show up near the product they are related to.

Without customization, you can set up any combination of Related relationships between products, sections, and categories. To use any of the other relationship types, you must customize the JSPs. See the chapter, Advanced Display, for more information.

List View for Related Products

The List view allows the iStore user to view related products vertically. By default related products are in displayed in the List view. The iStore user can perform the following actions in the List view:

Note that when you create associations between products and sections or categories, you are actually relating only the products within these categories and sections, not the categories or sections themselves. For example, if you set up a relationship between Product A and Section 1, Product A will be related to all of the products within Section 1. Likewise, if you set up an association between Category A and Category B, then it is the products within these categories that are associated in the Customer UI, not the categories themselves. If you wish to exclude some of the products within a related category or section, then you must use the exclusion feature. See the section, "Using Relationship Product Exclusion/Inclusion Functionality", within this chapter, for more information.

Display Templates to Show the Related Products

You must use one of the following seeded product Display Templates to display the Related relationship type:

See the section, "Product Templates", within this chapter, for more information.

How to Map the Relationships

You can map relationships using one of two methods:

Note: You cannot use both methods in a single relationship. Additionally, if you set up an SQL rule with a relationship type, you cannot delete it. You can, however, remove any mapping rules that you have set up.

Using the Relationships pages within the Site Administration UI, you can accomplish the following:

Creating Relationships Using Mapping Rules

For the seeded Related relationship type, you can set up mapping rules.

To set up mapping rules, log in to the Site Administration Application and select Catalog, Relationships.

Guidelines

Using Relationship Product Exclusion/Inclusion Functionality

Once you have set up a mapping rule for a relationship type, you may wish to exclude specific products from the rule.

To exclude product(s) from a rule, log in to the Site Administration UI and select Catalog, Relationships, Update icon, View Results, Include/Exclude.

Guidelines

Direct Punchout Catalog

This section describes the Direct Punchout Catalog functionality with Oracle iStore.

Note: Oracle Procurement uses the term, zones, for catalogs.

Overview of Direct Punchout Catalog

Implementing Oracle iStore as a direct punchout catalog allows companies to use Oracle iStore as an online catalog accessible from Oracle iProcurement or other third-party procurement systems. The Oracle iStore administrator manages the direct punchout catalog independent of the procurement site. In this type of implementation, buyers navigate from their companies' procurement systems to the Oracle iStore Customer Application online catalogs, then browse for and select items for purchase. Buyers submit their requisitions, which can be tied to a purchase order, into the procurement system. Oracle iStore’s support of multiple storefronts, built-in security mechanisms, and support for customer-negotiated pricing allow easy setup and administration of Direct Punchout Catalog.

Note: Out-of-box integration is provided for Oracle iProcurement only, using OAG XML and CXML protocols. Alternatively, any other protocols can be supported by implementing the exposed interfaces and registering them with Oracle iStore.

User Roles

The following user roles for Direct Punchout Catalog will be used throughout this section:

Direct Punchout Process Flow

Following is the high-level process flow when using Oracle iStore Direct Punchout Catalog functionality:

  1. A buyer logs into a procurement application and starts a new purchase requisition. The procurement system may or may not provide its own catalog, but will have links to one or more supplier catalogs.

  2. When the buyer selects an Oracle iStore catalog link, the procurement application sends the login request document to Oracle iStore. Oracle iStore validates the user credentials and sends a login response document to the procurement system. If the login was successful, the procurement system redirects the buyer to the Oracle iStore catalog URL available in the login response document. If the buyer has access to only one site, he will be redirected to that site's catalog (this is standard, non-punchout behavior in Oracle iStore).

  3. The buyer browses and/or searches the catalog and selects items to purchase. These items are temporarily stored in an Oracle iStore shopping cart.

  4. When the buyer is finished shopping, he selects the Checkout button.

  5. The items in the shopping cart are carried to the procurement application in real-time, and those items appear in the shopping cart in the procurement application. The shopping cart's quote status is updated to Store PunchedOut.

  6. The buyer checks out with his shopping cart in the procurement application to complete a purchase requisition.

Oracle iStore Site Setup

In a typical implementation, the Oracle iStore administrator sets up one or more sites where buyers from one or more procurement systems may select products. These storefronts are invisible to "regular" customers. Conversely, sites accessible to regular customers are invisible to buyers from procurement systems. The supplier can, however, implement common sites for procurement users and regular customers.

Some features available in customer sites will be disabled in sites meant for procurement users (these changes are discussed later in this section).

Note: Although the Oracle iStore administrator can set up separate sites for procurement users, it is not a mandatory setup. User interface functionality and flows will vary for procurement users and regular customers, but it will be done programmatically, specifically by checking the user type in the session context (see "Procurement User Session", below).

Procurement User Account

In Oracle iStore, a proxy user account (one for each buyer organization) is used to display the catalog and conduct transactions. Therefore, there is not a one-to-one match between the buyers (procurement users) and the Oracle iStore users. The proxy user is set up by the Oracle iStore administrator. Self-service registration is disabled in punchout mode.

In the recommended setup, the proxy user is a standard B2B user. He has a "employee of" relationship with the organization in Oracle TCA and an entry in the FND_USER table in Oracle Applications. The proxy user is always a local user, even if integrating with Oracle Single Sign-On Server (SSO).

The buyer will see the site picker page as the start page in Oracle iStore. Of course if the buyer has access to only one site, he will be redirected to the site catalog, which is current behavior in Oracle iStore.

Setting up of the Punchout Session

Setting up of the punchout session works as follows:

  1. The procurement user logs into the procurement system. When he chooses an Oracle iStore online catalog for shopping, a login request document is sent to Oracle iStore for authentication. If the credentials are correct, iStore generates a success login response document and sends it to procurement system. The procurement system obtains the catalog URL from this document and redirects the procurement user.

  2. The supplier site returns a punchout setup response, in the form of an XML document, containing a URL that informs the procurement application of the start page for a browsing session on the supplier site.

  3. If there is a login or authentication error, an appropriate message will be sent back in the punchout setup response. Since the procurement system is responsible for any error message shown, Oracle iStore doesn't seed a specific error to be displayed; the procurement system generic login failure error will display by default.

See "XML Documents", below, for more information on the documents.

User Session Behavior

Oracle iStore Customer UI behavior and the behavior of certain flows are different when the user is recognized as a procurement buyer. Oracle iStore uses the user type parameter in the session context to identify its standard users. The user type, procurement user, in the session context identifies buyers coming in from procurement systems.

Although only one proxy user account is stored in the database in the supplier site, multiple sessions are supported. Each session has a separate shopping cart, and the cart ID also is stored in the session context. The return URL will be stored in the session context.

In the event of Oracle Web Cache integration, different versions of pages will be cached for procurement users (the procurement user type is already added to the Web Cache version cookie).

Session time-out behaves similarly to any other user (customer, internal user, etc.) in the system. No special handling takes place for procurement users.

Oracle iStore recognizes the buyer’s language (available in the punchout setup request), provided the language is supported by the site. If not, the default language of the supplier site will be used.

Customer Application Page Display

Following are the changes for the Customer Application display pages when the user is recognized as a procurement buyer.

Support for Items

Oracle iProcurement currently does not maintain relationships between items; therefore, by default, certain restrictions exist on the types of items that can be purchased via catalog punchout, as shown below.

Supported Items

Unsupported Items

Special Rules for Promotional Items

Note that programmatically, Oracle iStore does not enforce the restrictions on item types.

Send Shopping Cart

In a catalog punchout session, the checkout button in the shopping cart is a link to a processing page that creates an XML document with the shopping cart items and sends it to the procurement system. (See "XML Documents", below, for more information on the documents.) If there are two shopping carts in two different operating units in two different specialty sites, only the cart in the current operating unit will be sent. The shopping cart sender page is a status page that will temporarily appear on the browser and then automatically redirect to the procurement system. The message that appears is "Sending shopping cart to procurement system...". This message can be modified by modifying the following FND message: IBE_PRMT_PO_CHKOUT_WAIT.

If the buyer decides to return to the procurement system without selecting any item, he can do so by selecting the Return to Procurement global navigation link. In this case, an XML document with no items will be sent to the procurement system. Refer to the section, "Customer Application Page Display", above, for more information on the Return to Procurement global navigation link.

Hand-off from iStore happens when the shopping cart is sent to the procurement site. How the procurement system sends the purchase order to the order management system of the supplier site is determined by the implementer outside of the Oracle iStore implementation, as is the freezing of prices in the purchase order.

The shopping cart contains several attributes whose values are certain codes. These are unit of measure (UOM) codes, currency codes, categories, languages codes, etc. All of these codes, except language, will be sent in Oracle E-Business Suite-supported codes. Language will be sent in ISO language code.

Note: For the purposes of Oracle Daily Business Intelligence and/or lead import functionality, punchout carts are not considered.

Cart (Quote) Status Transitions

When a buyer creates a cart in Oracle iStore by adding an item to the cart, the Oracle Quoting source code will be iStore ProcPunchout, and the quote status will be Store Draft. When the buyer checks out, the quote status will change to Store Punchedout. The source code will remain iStore ProcPunchout.

Security and Privacy

Procurement users can access catalog pages (including the Specialty Site Page) and shopping cart pages only. Forced browsing to other pages is disallowed.

XML Documents

The following table describes the Oracle Native XML document and cXML documents for the setting up of the punchout session and send shopping cart events.

XML Documents Involved in Catalog Punchout
Document Purpose Oracle Native XML Document cXML Document Comments
Setting up of the Punchout Session loginRequest, loginResponse PunchOutSetupRequest, PunchOutSetupResponse Procurement system generates an XML document, which includes a base set of user details and the return URL for the procurement instance. The supplier generates an XML document accepting the requester’s logon.
Send Shopping Cart shoppingCart PunchOutOrderMessage iStore sends the shopping cart information to the procurement system in a URL-encoded XML document.

Display Templates

The following Customer Application Display Templates are involved in the Direct Punchout Catalog functionality:

By default, these templates are mapped to supplied JSPs. For more information on these templates, see the Seeded Display Data, appendix.

Oracle iStore Implementation Tasks for Direct Punchout Catalog

This section describes the Oracle iStore implementation steps required for the functionality. Following are the steps:

  1. Step 1 - Set Profile Options

  2. Step 2 - Create Buyer Organization and User

  3. Step 3 - Create Oracle iStore Sites

  4. Step 4 - Send Information to Procurement Organization

For more information, see Oracle Procurement Buyer’s Guide to Punchout and Transparent Punchout and theOracle Procurement Supplier’s Guide to Punchout and Transparent Punchout.

Step 1 - Set Profile Options

Set the profile option, IBE: Merchant DUNS Number, to the supplier’s DUNS number at site level. If supplier has multiple DUNS numbers, set at responsibility level.

Set the profile option, JTF_UM_MERCHANT_NAME, to the merchant name (e.g., Oracle iStore) at site level.

Step 2 - Create Buyer Organization and User

Create the buyer organization as a customer and create a proxy contact for the organization (if the buyer organization already exists, there is no need to create a new organization):

  1. Log in into Oracle Forms and select Trading Community Manager responsibility.

  2. Navigate to Customers, Standard.

  3. Enter customer data:

  4. Save the changes.

Create a username and password for the buyer proxy contact:

  1. Switch Responsibility to System Administrator.

  2. Navigate to Security, User.

  3. Enter user data:

  4. Save the changes.

Step 3 - Create Oracle iStore Sites

Create Oracle iStore sites where the buyer will purchase items. Dedicated sites can be created, or existing sites can be utilized.

To restrict a site to the procurement organization, you may use the organization access restrictions functionality and restrict the site to only the procurement organization (also disallow the buyer organization from all other sites). If a dedicated site is not required, this step is not required.

See the chapter Implementing Site Management, for more information.

Step 4 - Send Information to Procurement Organization

As the host of the Oracle iStore catalog, send the following information to the procurement organization:

If Using Oracle Native XML Protocol

If using Oracle Native XML protocol for the messaging, send the following:

If Using cXML Protocol

If using cXML protocol for the messaging, send the following:

Oracle iProcurement Implementation Tasks for Direct Punchout Catalog

If using Oracle iProcurement for the procurement system, complete the implementation steps in this section. Following are the high-level steps:

  1. Step 1 - Set up Data Mapping

  2. Step 2 - Create Punchout Catalog

  3. Step 3 - Publish Catalog

For more information, see Oracle Procurement Buyer’s Guide to Punchout and Transparent Punchout and the Oracle Procurement Supplier’s Guide to Punchout and Transparent Punchout.

Step 1 - Set up Data Mapping

Item categories and units of measure (UOM) used at the supplier site may not match those at the procurement site. Oracle iProcurement leverages Oracle XML Gateway’s capability to transform this data when a shopping cart is received from supplier.

Define the mapping in Oracle XML Gateway:

  1. Log in to Oracle Self Service Web Applications.

  2. Select eCommerce Gateway, Vision Enterprises responsibility.

  3. Navigate to Setup, Code Conversion, Define Code Conversion Values.

  4. For each item category in the supplier's inventory database, enter the following:

  5. For each UOM in the supplier inventory, enter the following:

Step 2 - Create Punchout Catalog

Create the punchout catalog:

  1. Log in to Oracle Self Service Web Applications.

  2. Select the iProcurement Catalog Administration responsibility.

  3. Navigate to Manage Content, Catalogs, Create.

  4. Enter the following data for the catalog:

  5. Submit the configuration.

Step 3 - Publish Catalog

In Oracle iProcurement, publish the catalog:

  1. Navigate to Manage Content, Stores, Create Store (an existing store can also be used instead).

  2. Enter the store information:

  3. Submit.