|Oracle iStore Implementation and Administration Guide|
Part Number E13575-06
This chapter covers the following topics:
This chapter provides an overview of the tasks required to configure and customize Oracle iStore message text and message prompts.
In Oracle iStore, the Customer Application pages display various messages. The text for most of the messages comes from the Oracle Applications Message Dictionary (AOL). Each Message Type or Message Name in AOL is associated to a single block of content for every supported language. Oracle iStore ships with hundreds of seeded AOL messages and associated seeded message text for the Customer and Site Administration UIs. The seeded text can be found in the FND_NEW_MESSAGES table.
Several of the AOL text messages are seeded as media objects in the Site Administration Media Objects pages. See the chapter, Implementing Content, for details.
The following table lists a few examples of seeded message text for the Customer and Site Administration UIs.
|Message Name||Message Text||User Interface||Context|
|IBE_M_ADD_PRODUCTS_LBL||Add products to the section||Site Administration UI: Product Catalog||Description for adding products to a section page|
|IBE_M_CONFIRM||Are you sure?||Site Administration UI||Confirmation message for deleting a site|
|IBE_PRMT_EXPRESS_CHKOUT_PREF_G||Express Checkout||Customer UI: Personal Information Profile Pages||Text that appears on top of Personal Information Page|
|IBE_PRMT_WELCOME_G||Welcome||Customer UI: Welcome Bin||Text that appears in the Welcome Bin|
The seeded text in bins may not apply to your implementation, and you may want to change the default text.
Note that text content imbedded against an AOL prompt cannot be deleted. A new FND prompt should be created if new text needs to be added to a prompt, or the prompt should be deleted and a new one created. If a prompt is deleted, bounce the server in order for the existing message attached to the prompt to be removed from the Customer UI.
Use the following procedure to change the text of an Oracle Application Object Library (AOL) message.
For instructions on how to find the name of a specific message, see the section, "Locating Text in JSPs", below.
Log in to Oracle Forms with the Application Developer responsibility and select Application, then Messages. The Messages window opens.
Choose View, then Find. The Messages search window opens.
All seeded Oracle iStore text messages begin with the product code, IBE. In the Find field, enter IBE% and select Find. Your search results display in the Messages search window.
Select the message that you want to modify and select OK. The Messages window is populated with the selected message.
Modify the message text for the appropriate language.
It is recommended that you bounce the Apache server after making any message text changes.
It may be cumbersome for you to locate specific messages found in the Customer or Site Administration UI. To simplify the process, you can find a specific message name by viewing the source code of the JSP file displaying it. Use the following procedure to locate AOL message text found in the Oracle iStore JSPs.
As a prerequisite, ensure you have a UNIX account and access to the OA_HTML directory.
In the Customer UI, navigate to a page containing message text. For example, navigate to the Site Home Page (ibeCZzpHome.jsp) that displays the Welcome Bin.
From the browser menu bar choose View > Source.
Search for the text you wish to locate.
In the source file, search for the JSP that correlates to the bin containing the associated message.
For example, the Welcome text is found in the ibeCAcdWelcome.jsp.
Log onto the application server and navigate to the OA_HTML directory. Once here, do a search for the ibe*.jsp that you are looking for.
In the Welcome example, locate ibeCAcdWelcome.jsp.
Open the JSP file and locate the AOL Message Name that correlates to the text you are looking for.
In the Welcome example, the AOL Message name is IBE_PRMT_Welcome_G.
Modify the message if desired, using the steps in the section, "Modifying Text Messages", in this chapter.
Specialty site text messages, prompts, and labels can be translated into multiple languages. If you have properly installed and implemented multiple languages, the seeded content will be translated automatically. However, if you have modified the seeded messages, then you will need to manually translate the text, prompt, or label.
For example, the Welcome Bin has the default text in American English -- Welcome. If Spanish has been properly implemented as an additional language, then the seeded text Welcome is automatically translated to Bienvenido in the Spanish site. If the seeded content has been altered, then the translation will not happen automatically and must be configured manually.
In addition to translating messages and customizing default text for messages, you can also display different messages for particular types of sites. For example, a single Oracle iStore implementation may have three different sites that are active. In this example, one of the three sites is a B2B site which allows customers to place an order by faxing a purchase order. The other two sites are B2C sites and do not accept purchase orders. The B2B site, then, must have a specific text message that communicates this functionality in the Customer Application.
In Oracle iStore it is possible to map specific messages to specific sites using the Site Administration Application's media object functionality. The site-specific message is created and saved as an HTML file. Then, the new message (HTML file) is added as a source file for a media object and mapped to a particular site using the Site Administration Application.
See also: the chapter, Implementing Content
You can add custom messages for sites using the Oracle Applications Message Dictionary, the Oracle iStore media objects functionality, and the Java API DisplayManager.getTextMediaOrFndMsg().
Create an HTML file with the desired text message.
If you are storing your media source files in the file system, place the HTML file in the /OA_MEDIA directory.
If you are storing your media source files in the database, upload the HTML file to the database or place it in your local directory for upload during the procedure.
Create the default message in Oracle Applications Message Dictionary as follows:
Log in to Oracle Forms with the Application Developer responsibility.
Choose Application, then Messages. The Messages window opens.
Create a new message. The Oracle convention for an Oracle iStore message name begins the name with IBE.
Create translations if necessary.
Save the message.
In Oracle iStore, create a media object with the same programmatic access name as the Oracle Applications Message Dictionary message name. See the chapter, Implementing Content, for instructions.
Add the HTML source file to the media object as described in the "Implementing Contetnt" chapter. Use the following guidelines:
Map the HTML file to the specialty site where you want it to appear.
Do not set the HTML file as the default source file.
In the JSP that should display the message, use the DisplayManager.getTextMediaOrFndMsg() API to call the message.
For example, if the message name is IBE_STORE_WELCOME and you want to display it in your sites' home pages (ibeCZzpHome.jsp), you would add the following API call in the common section page, ibeCCtdCmnSt.jsp:
You can use the "get msg" API in any JSP that is not a processing page, using the programmatic name of the message from Forms.
Oracle iStore supplies placeholders on the shipping, billing, order review/confirmation, and shopping cart pages of the Customer Application which implementers can use to supply custom text for customers.
To use the custom prompt placeholders:
Create a new media object of Message type, using the programmatic access name of the custom text prompt. Instructions for this procedure can be found in the chapter, Implementing Content.
Or, create an Oracle Application Object Library (FND) message using the programmatic access name of the custom text prompt. To get started on this procedure, see the section, "Site Text Messages Overview", in this chapter.
The following table lists selected custom text placeholders supplied for the shipping, billing, order review/confirmation, and shopping cart pages.
|Programmatic Access Name||Description|
|IBE_PRMT_ENDTCA_CSTM_MSG1||Custom prompt on B2B end customer search page|
|IBE_PRMT_ENDTCA_CSTM_MSG2||Custom prompt on B2B end customer contact search page|
|IBE_PRMT_ENDTCA_CSTM_MSG3||Custom prompt on B2B end customer address search page|
|IBE_PRMT_SHP_CSTM_MSG1||Custom prompt on B2B Shipping (ibeCCkdBHdrShip.jsp) page|
|IBE_PRMT_SHP_CSTM_MSG2||Custom prompt on B2B Shipping (ibeCCkdBHdrShip.jsp) page|
|IBE_PRMT_SHP_CSTM_MSG5||Custom prompt on B2B Shipping (ibeCCkdBHdrShip.jsp) page|
|IBE_PRMT_SHP_CSTM_MSG6||Custom prompt on B2B Shipping (ibeCCkdBHdrShip.jsp) page|
|IBE_PRMT_SHP_CSTM_MSG7||Custom prompt on B2B Shipping (ibeCCkdBHdrShip.jsp) page|
|IBE_PRMT_SHP_CSTM_MSG1||Custom prompt on B2C Shipping (ibeCCkdCHdrShip.jsp) page|
|IBE_PRMT_SHP_CSTM_MSG2||Custom prompt on B2C Shipping (ibeCCkdCHdrShip.jsp) page|
|IBE_PRMT_SHP_CSTM_MSG3||Custom prompt on B2C Shipping (ibeCCkdCHdrShip.jsp) page|
|IBE_PRMT_SHP_CSTM_MSG4||Custom prompt on B2C Shipping (ibeCCkdCHdrShip.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG1||Custom prompt on B2B Billing (ibeCCkdBHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG9||Custom prompt on B2B Billing (ibeCCkdBHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG10||Custom prompt on B2B Billing (ibeCCkdBHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG11||Custom prompt on B2B Billing (ibeCCkdBHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG14||Custom prompt on B2B Billing (ibeCCkdBHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG12||Custom prompt on B2B Billing (ibeCCkdBHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG13||Custom prompt on B2B Billing (ibeCCkdBHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG1||Custom prompt on B2C Billing (ibeCCkdCHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG4||Custom prompt on B2C Billing (ibeCCkdCHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG6||Custom prompt on B2C Billing (ibeCCkdCHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG14||Custom prompt on B2C Billing (ibeCCkdCHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG7||Custom prompt on B2C Billing (ibeCCkdCHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG8||Custom prompt on B2C Billing (ibeCCkdCHdrBillPay.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG2||Custom prompt on Billing - Payment Options (ibeCPmdPmtOptions.jsp) page|
|IBE_PRMT_BIL_CSTM_MSG3||Custom prompt on Billing - Payment Options (ibeCPmdPmtOptions.jsp) page|
|IBE_PRMT_ORD_NEW_CREDIT_CARD||Custom prompt on Billing - Payment Options (ibeCPmdPmtOptions.jsp) page|
|IBE_PRMT_PMTBK_FAX_CC_MSG||Custom prompt on Billing - Payment Options (ibeCPmdPmtOptions.jsp) page|
|IBE_PRMT_PMTBK_PO_MSG||Custom prompt on Billing - Payment Options (ibeCPmdPmtOptions.jsp) page|
|IBE_PRMT_ORD_CSTM_MSG1||Custom prompt on Order Review (ibeCCkdOrdReview.jsp) page|
|IBE_PRMT_ORDSUM_CSTM_MSG1||Custom prompt on Order Confirmation (ibeCCkdOrdSummary.jsp) page|
|IBE_PRMT_CRT_CSTM_MSG1||Custom prompt on Shopping Cart (ibeCScdShowCartSummary.jsp) page|
|IBE_PRMT_CRT_CSTM_MSG2||Custom prompt on Shopping Cart (ibeCScdShowCartSummary.jsp) page|
|IBE_PRMT_CRT_CSTM_MSG3||Custom prompt on Shopping Cart (ibeCScdViewA.jsp) page|
|IBE_PRMT_ORD_FLEX_DESCR||Custom prompt on Shopping Cart (ibeCScdViewA.jsp) page|
|IBE_PRMT_SHPTCA_CSTM_MSG1||Custom Prompt on B2B Ship to Customer Search (ibeCCkdSearchCust.jsp) page|
|IBE_PRMT_BILTCA_CSTM_MSG1||Custom Prompt on B2B Billto Customer Search (ibeCCkdSearchCust.jsp) page|
|IBE_PRMT_SHPTCA_CSTM_MSG2||Custom Prompt on B2B Shipto Contact Search (ibeCCkdSearchCntct.jsp) page|
|IBE_PRMT_BILTCA_CSTM_MSG2||Custom Prompt on B2B Billto Contact Search (ibeCCkdSearchCntct.jsp) page|
|IBE_PRMT_SHPTCA_CSTM_MSG3||Custom Prompt on B2B Shipto Address Search (ibeCCkdSearchAddr.jsp) page|
|IBE_PRMT_BILTCA_CSTM_MSG3||Custom Prompt on B2B Billto Address Search (ibeCCkdSearchAddr.jsp) page|
|IBE_PRMT_SCART_CSTM_MSG1||Custom Prompt on View Saved Cart (ibeCScdViewS.jsp) page *|
|IBE_PRMT_SQUOTE_CSTM_MSG1||Custom Prompt on View Saved Quote (ibeCScdViewQ.jsp) page *|
|IBE_PRMT_SHCART_CSTM_MSG1||Custom Prompt on View Shared Cart (ibeCScdViewSharedCart.jsp) page *|
|IBE_PRMT_SHQUOTE_CSTM_MSG1||Custom Prompt on View Shared Quote (ibeCScdViewSharedQuote.jsp) page *|
|* These prompts display only if the cart/quote are updateable by the user.|
The prompts in the Login and Password Assistance page are seeded Oracle Applications Message Dictionary messages. Oracle iStore also uses Oracle Applications Message Dictionary messages when it sends an e-mail with a customer's login information after the customer uses self-service login assistance. These messages are listed in the following table.
The following table, Self-Service Login Assistance Messages, shows the Self-Service Login Assistance messages that are seeded in the Customer UI.
|Message Name||Description||Seeded Text|
|IBE_PWD_EMAIL_BODY||The body of the e-mail sent to users with their login information||Dear &0,|
You are receiving this email because we recently received a request to e-mail your login information to you.
You do not have to respond to or act on this email.
Your account details are given below:
As a security measure you should change your password immediately after logging on.
IMPORTANT: Do not reply to this email. If you need to contact us, send an email to firstname.lastname@example.org.
We appreciate your interest with us.
|IBE_PWD_EMAIL_SUBJECT||The subject line of the e-mail sent to users with their login information||Login information assistance|
|IBE_PWD_HELP_FOOTER||Tells customers who to contact for additional help||If you need additional help regarding your login information, feel free to send email to email@example.com. We will be happy to assist you.|
|The strings preceded by an ampersand (&) are dynamically replaced with user-specific information by Oracle iStore.|
You must modify the messages IBE_PWD_EMAIL_BODY and IBE_PWD_HELP_FOOTER to change the seeded e-mail address firstname.lastname@example.org to your own site administrator's e-mail address.
Oracle Application Object Library lookups (FND_LOOKUPS) provide some of the lists of values in the Customer UI and the Site Administration UI. You can change the values of the names and descriptions for these lookups by using the following procedure.
Information about the seeded lookups can be found later in this section.
Log in to Oracle Forms with the Application Developer responsibility.
Navigate to Application, Lookups, Application Object Library. The Application Object Library Lookups window opens.
Choose View, then Find. The Lookup Types search window opens.
Query for the lookup which you are modifying.
In each row of the Application Object Library Lookups window, you can add a lookup code as follows:
In the Code field, enter the lookup code.
In the Meaning field, enter a meaning for the lookup code.
In the Description field, enter a description for the lookup code. This is the description that will show up in the Customer UI drop down list.
Optional: In the From and To fields, select the effective dates for the lookup code.
Check the Enabled checkbox.
Save the form.
To disable a lookup code, end date it and uncheck the Enable flag for the code.
Customers can request help from a sales representative through iStore's Sales Assistance feature. You can use AOL to activate and set up the list of reasons for needing assistance that customers choose from when using the Sales Assistance feature. You accomplish this by setting up lookup codes with meanings for the AOL lookup type ASO_SALESREP_ASSISTANCE_REASON.
The following table shows the seeded Sales Assistance Prompts.
|Message Name||UI Prompt Content|
|IBE_SA_MORE_PRODUCT_INFO||More Product Info|
|SA_TANDC||Terms and Conditions|
For more information on Oracle iStore's Sales Assistance feature, see the chapter, Implementing Customer Assistance.
Site administrators can change the seeded names and descriptions for shared cart roles. You accomplish this by changing lookup codes with meanings for the AOL lookup type, IBE_QUOTE_UPDATE_PRIVILEGE. The seeded values are:
See the chapter, Implementing Carts and Orders, for more information.
Site administrators can change the class designations for the media objects and content components in the Site Administration UI. To do this, you must modify the lookup, IBE_M_MEDIA_OBJECT_APPLI_TO.
The following table, Seeded Media Object and Content Component Classes, shows the seeded classes for these items:
|Access Level Name||Description|
|Product||For media objects or components applicable to product display|
|Section||For media objects or components applicable to section display|
|Section and Product||For media objects or components applicable to section and product display|
|Message||For media objects applicable to message display|
|Logo||For media objects applicable to logo display|
|Others||For all other classes|
Oracle iStore's site management functionality allows you to categorize specialty sites into groups. The specialty sites then display in the Site Selection Page according to the group(s) in which they belong. The names of the groups are extensible lookups which you can alter according to your business needs. You also can disable the groups. To do this, you must modify the lookup, IBE_M_SITE_GROUP.
When you create a new group lookup or alter an existing group lookup in Oracle Forms, the changes appear immediately in the Store Administration UI, but you need to bounce the server for the changes to be visible in the Customer UI.
The following table shows the seeded groups:
|Site Group Name||Description|
|Store Sites||A group for Oracle iStore specialty sites|
|Support Sites||A group for Oracle iSupport specialty sites|
|Partner Sites||A group for Oracle Partner Management specialty sites|
In Oracle iStore's Returns pages, you can modify the LOV that displays the reasons a user is returning an order. The name of the Return Reasons lookup is IBE_RETURN_REASONS_LOOKUP.
The seeded reasons are:
Important: When entering new lookup values, you must use values that exist in the lookup, CREDIT_MEMO_REASON. This is an Oracle Receivables lookup. If you do not use one of these values, and a user submits a return using an invalid reason, the return will fail.
You also can modify the values displayed in the Returns search mechanism. See the section, "Order Tracker Search Lookups", below.
In Order Tracker's Track Orders page, the search utility lookup is displays as Orders in Last Days. The same lookup is used for Orders, Invoices, Payments, and Returns queries.
Following is the data:
Lookup Name: IBE_QUERY_ORDERS_RANGE_LOOKUP
Description: Lookup for defining data range to query orders
Values: 7, 14, 30, 60, 90 days
Default value: 7 days
Note that the search will default to the lookup's first entered value.
If you have set up values with decimals, Oracle iStore rounds off this value before displaying the results. For example, 1.5 would be treated as 1 and search results would be returned for 1 day.
In the Advanced Search page of Order Tracker, the Status field can be displayed either at the item or order level. This display is accomplished by selecting either Orders or Items in the Search By list.
In the Invoices page of Order Tracker, the iStore user can select the Type and the Contains item from the Search By list. Enter credit in the Search field and click on the Go button to view the credit memo in the Type column.
The lookup for the Status field, when Orders is selected in the Search by LOV, is: IBE_ORDER_STATUS_SEARCH_PARAMETERS. The seeded lookup values are:
The lookup for the Status field, when Items is selected in the Search by LOV, is: IBE_LINE_STATUS_SEARCH_PARAMETERS. The seeded lookup values are:
Important: If you modify these values, be sure to enter the same values in the Oracle Order Management lookups that store order statuses. These are FLOW_STATUS, the lookup for order header statuses; and LINE_FLOW_STATUS, the lookup for order line statuses. To view/alter these statuses, navigate to Setup: Quick Codes in the Order Management Super User menu.
The lookup associated with the profile, IBE: View-By Customer Orders in Order Tracker, is IBE_OT_VIEWBY_CUST_ORDERS.
The lookups for user types are shown below. These lookups effect the display of the links in the user type listing Registration page. Each main lookup has two or more child lookups within it.
B2C User Types
IBE_UM_INDIVIDUAL_USER_TYPES: These lookups are for individual (B2C) user types.
IBE_INDIVIDUAL (for iStore B2C users)
IBE_INDIVIDUAL_PARTIAL (for iStore B2C users for Online Access to Existing Account functionality)
IBU_INDIVIDUAL (for iSupport B2C users)
B2B User Types
IBE_UM_STORE_USER_TYPES: These lookups are for individual (B2B) user types.
IBE_BUSINESS (for iStore regular B2B users)
IBE_BUSINESS_PARTIAL (for iStore B2B Online Access to Existing Account users)
IBE_PRIMARY (for iStore primary users)
IBU_BUSINESS (for iSupport regular B2B users)
IBU_BUSINESS_PARTIAL (for iSupport B2B Online Access to Existing Account users)
IBU_PRIMARY (for iSupport primary users)
Non-Administrative B2B and Partner User Types
IBE_UM_SECONDARY_USER_TYPES: These lookups are for non-administrative business (B2B) user types and user types to register Oracle Partner Management non-administrative users.
IBE_BUSINESS (for iStore regular B2B users)
IBE_BUSINESS_PARTIAL (for iStore regular B2B user for Online Access to Existing Account functionalitys)
IBE_PARTNER_BUSINESS (for Partner Management regular users)
Primary B2B and Partner User Types
IBE_UM_PRIMARY_USER_TYPES: These lookups are for primary (administrative) business (B2B) user types and user types to register Oracle Partner Management primary users.
IBE_PRIMARY (for iStore primary users)
IBE_PARTNER_PRIMARY (for Partner Management primary users)
Partner User Types
IBE_UM_PARTNER_USER_TYPES: These lookups are for Oracle Partner Management users.
IBE_PARTNER_BUSINESS (for B2B partners, non-administrative)
IBE_PARTNER_PRIMARY (for B2B primary user partners)
IBU_BUSINESS_PARTNER (for iSupport B2B partners, non-administrative)
Partial Registration User Types
IBE_UM_PARTIAL_USER_TYPES: These lookups are for user types registering with Online Access to Existing Account functionality.
IBE_BUSINESS_PARTIAL (for B2B Online Access to Existing Account users)
IBE_INDIVIDUAL_PARTIAL (for B2C Online Access to Existing Account users)
IBU_BUSINESS_PARTIAL (for iSupport B2B Online Access to Existing Account users)
IBU_INDIVIDUAL_PARTIAL (for iSupport B2C Online Access to Existing Account users)
See the chapter, Implementing User Management, for more information.
Oracle iStore seeds the names of popular Web crawler user agents in the lookup, IBE_SEARCH_ENGINE_USER_AGENTS. The seeded values are:
Ask Jeeves: Teoma
For more information, see the "Search Engine Indexing" section in the chapter, Implementing Miscellaneous Internet-Related Features.
Copyright © 2001, 2010, Oracle and/or its affiliates. All rights reserved.